Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/arm-datafactory

Index

Classes

Interfaces

Type aliases

Variables

Object literals

Type aliases

ActivityRunsQueryByPipelineRunResponse

ActivityRunsQueryByPipelineRunResponse: ActivityRunsQueryResponse & object

Contains response data for the queryByPipelineRun operation.

ActivityUnion

Contains the possible cases for Activity.

AzureSearchIndexWriteBehaviorType

AzureSearchIndexWriteBehaviorType: "Merge" | "Upload"

Defines values for AzureSearchIndexWriteBehaviorType. Possible values include: 'Merge', 'Upload'

readonly
enum

{string}

BlobEventTypes

BlobEventTypes: "Microsoft.Storage.BlobCreated" | "Microsoft.Storage.BlobDeleted"

Defines values for BlobEventTypes. Possible values include: 'Microsoft.Storage.BlobCreated', 'Microsoft.Storage.BlobDeleted'

readonly
enum

{string}

CassandraSourceReadConsistencyLevels

CassandraSourceReadConsistencyLevels: "ALL" | "EACH_QUORUM" | "QUORUM" | "LOCAL_QUORUM" | "ONE" | "TWO" | "THREE" | "LOCAL_ONE" | "SERIAL" | "LOCAL_SERIAL"

Defines values for CassandraSourceReadConsistencyLevels. Possible values include: 'ALL', 'EACH_QUORUM', 'QUORUM', 'LOCAL_QUORUM', 'ONE', 'TWO', 'THREE', 'LOCAL_ONE', 'SERIAL', 'LOCAL_SERIAL'

readonly
enum

{string}

ControlActivityUnion

Contains the possible cases for ControlActivity.

CopyBehaviorType

CopyBehaviorType: "PreserveHierarchy" | "FlattenHierarchy" | "MergeFiles"

Defines values for CopyBehaviorType. Possible values include: 'PreserveHierarchy', 'FlattenHierarchy', 'MergeFiles'

readonly
enum

{string}

CopySinkUnion

Contains the possible cases for CopySink.

CopySourceUnion

Contains the possible cases for CopySource.

CopyTranslatorUnion

CopyTranslatorUnion: CopyTranslator | TabularTranslator

Contains the possible cases for CopyTranslator.

DatasetCompressionLevel

DatasetCompressionLevel: "Optimal" | "Fastest"

Defines values for DatasetCompressionLevel. Possible values include: 'Optimal', 'Fastest'

readonly
enum

{string}

DatasetCompressionUnion

Contains the possible cases for DatasetCompression.

DatasetStorageFormatUnion

Contains the possible cases for DatasetStorageFormat.

DatasetUnion

Contains the possible cases for Dataset.

DatasetsCreateOrUpdateResponse

DatasetsCreateOrUpdateResponse: DatasetResource & object

Contains response data for the createOrUpdate operation.

DatasetsGetResponse

DatasetsGetResponse: DatasetResource & object

Contains response data for the get operation.

DatasetsListByFactoryNextResponse

DatasetsListByFactoryNextResponse: DatasetListResponse & object

Contains response data for the listByFactoryNext operation.

DatasetsListByFactoryResponse

DatasetsListByFactoryResponse: DatasetListResponse & object

Contains response data for the listByFactory operation.

DayOfWeek

DayOfWeek: "Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday"

Defines values for DayOfWeek. Possible values include: 'Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'

readonly
enum

{string}

DaysOfWeek

DaysOfWeek: "Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday"

Defines values for DaysOfWeek. Possible values include: 'Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'

readonly
enum

{string}

Db2AuthenticationType

Db2AuthenticationType: "Basic"

Defines values for Db2AuthenticationType. Possible values include: 'Basic'

readonly
enum

{string}

DependencyCondition

DependencyCondition: "Succeeded" | "Failed" | "Skipped" | "Completed"

Defines values for DependencyCondition. Possible values include: 'Succeeded', 'Failed', 'Skipped', 'Completed'

readonly
enum

{string}

DependencyReferenceUnion

Contains the possible cases for DependencyReference.

ExecutionActivityUnion

Contains the possible cases for ExecutionActivity.

FactoriesConfigureFactoryRepoResponse

FactoriesConfigureFactoryRepoResponse: Factory & object

Contains response data for the configureFactoryRepo operation.

FactoriesCreateOrUpdateResponse

FactoriesCreateOrUpdateResponse: Factory & object

Contains response data for the createOrUpdate operation.

FactoriesGetGitHubAccessTokenResponse

FactoriesGetGitHubAccessTokenResponse: GitHubAccessTokenResponse & object

Contains response data for the getGitHubAccessToken operation.

FactoriesGetResponse

FactoriesGetResponse: Factory & object

Contains response data for the get operation.

FactoriesListByResourceGroupNextResponse

FactoriesListByResourceGroupNextResponse: FactoryListResponse & object

Contains response data for the listByResourceGroupNext operation.

FactoriesListByResourceGroupResponse

FactoriesListByResourceGroupResponse: FactoryListResponse & object

Contains response data for the listByResourceGroup operation.

FactoriesListNextResponse

FactoriesListNextResponse: FactoryListResponse & object

Contains response data for the listNext operation.

FactoriesListResponse

FactoriesListResponse: FactoryListResponse & object

Contains response data for the list operation.

FactoriesUpdateResponse

FactoriesUpdateResponse: Factory & object

Contains response data for the update operation.

FactoryRepoConfigurationUnion

Contains the possible cases for FactoryRepoConfiguration.

FtpAuthenticationType

FtpAuthenticationType: "Basic" | "Anonymous"

Defines values for FtpAuthenticationType. Possible values include: 'Basic', 'Anonymous'

readonly
enum

{string}

GoogleBigQueryAuthenticationType

GoogleBigQueryAuthenticationType: "ServiceAuthentication" | "UserAuthentication"

Defines values for GoogleBigQueryAuthenticationType. Possible values include: 'ServiceAuthentication', 'UserAuthentication'

readonly
enum

{string}

HBaseAuthenticationType

HBaseAuthenticationType: "Anonymous" | "Basic"

Defines values for HBaseAuthenticationType. Possible values include: 'Anonymous', 'Basic'

readonly
enum

{string}

HDInsightActivityDebugInfoOption

HDInsightActivityDebugInfoOption: "None" | "Always" | "Failure"

Defines values for HDInsightActivityDebugInfoOption. Possible values include: 'None', 'Always', 'Failure'

readonly
enum

{string}

HiveAuthenticationType

HiveAuthenticationType: "Anonymous" | "Username" | "UsernameAndPassword" | "WindowsAzureHDInsightService"

Defines values for HiveAuthenticationType. Possible values include: 'Anonymous', 'Username', 'UsernameAndPassword', 'WindowsAzureHDInsightService'

readonly
enum

{string}

HiveServerType

HiveServerType: "HiveServer1" | "HiveServer2" | "HiveThriftServer"

Defines values for HiveServerType. Possible values include: 'HiveServer1', 'HiveServer2', 'HiveThriftServer'

readonly
enum

{string}

HiveThriftTransportProtocol

HiveThriftTransportProtocol: "Binary" | "SASL" | "HTTP "

Defines values for HiveThriftTransportProtocol. Possible values include: 'Binary', 'SASL', 'HTTP '

readonly
enum

{string}

HttpAuthenticationType

HttpAuthenticationType: "Basic" | "Anonymous" | "Digest" | "Windows" | "ClientCertificate"

Defines values for HttpAuthenticationType. Possible values include: 'Basic', 'Anonymous', 'Digest', 'Windows', 'ClientCertificate'

readonly
enum

{string}

ImpalaAuthenticationType

ImpalaAuthenticationType: "Anonymous" | "SASLUsername" | "UsernameAndPassword"

Defines values for ImpalaAuthenticationType. Possible values include: 'Anonymous', 'SASLUsername', 'UsernameAndPassword'

readonly
enum

{string}

IntegrationRuntimeAuthKeyName

IntegrationRuntimeAuthKeyName: "authKey1" | "authKey2"

Defines values for IntegrationRuntimeAuthKeyName. Possible values include: 'authKey1', 'authKey2'

readonly
enum

{string}

IntegrationRuntimeAutoUpdate

IntegrationRuntimeAutoUpdate: "On" | "Off"

Defines values for IntegrationRuntimeAutoUpdate. Possible values include: 'On', 'Off'

readonly
enum

{string}

IntegrationRuntimeEdition

IntegrationRuntimeEdition: "Standard" | "Enterprise"

Defines values for IntegrationRuntimeEdition. Possible values include: 'Standard', 'Enterprise'

readonly
enum

{string}

IntegrationRuntimeInternalChannelEncryptionMode

IntegrationRuntimeInternalChannelEncryptionMode: "NotSet" | "SslEncrypted" | "NotEncrypted"

Defines values for IntegrationRuntimeInternalChannelEncryptionMode. Possible values include: 'NotSet', 'SslEncrypted', 'NotEncrypted'

readonly
enum

{string}

IntegrationRuntimeLicenseType

IntegrationRuntimeLicenseType: "BasePrice" | "LicenseIncluded"

Defines values for IntegrationRuntimeLicenseType. Possible values include: 'BasePrice', 'LicenseIncluded'

readonly
enum

{string}

IntegrationRuntimeNodesGetIpAddressResponse

IntegrationRuntimeNodesGetIpAddressResponse: IntegrationRuntimeNodeIpAddress & object

Contains response data for the getIpAddress operation.

IntegrationRuntimeNodesGetResponse

IntegrationRuntimeNodesGetResponse: SelfHostedIntegrationRuntimeNode & object

Contains response data for the get operation.

IntegrationRuntimeNodesUpdateResponse

IntegrationRuntimeNodesUpdateResponse: SelfHostedIntegrationRuntimeNode & object

Contains response data for the update operation.

IntegrationRuntimeSsisCatalogPricingTier

IntegrationRuntimeSsisCatalogPricingTier: "Basic" | "Standard" | "Premium" | "PremiumRS"

Defines values for IntegrationRuntimeSsisCatalogPricingTier. Possible values include: 'Basic', 'Standard', 'Premium', 'PremiumRS'

readonly
enum

{string}

IntegrationRuntimeState

IntegrationRuntimeState: "Initial" | "Stopped" | "Started" | "Starting" | "Stopping" | "NeedRegistration" | "Online" | "Limited" | "Offline" | "AccessDenied"

Defines values for IntegrationRuntimeState. Possible values include: 'Initial', 'Stopped', 'Started', 'Starting', 'Stopping', 'NeedRegistration', 'Online', 'Limited', 'Offline', 'AccessDenied'

readonly
enum

{string}

IntegrationRuntimeStatusUnion

Contains the possible cases for IntegrationRuntimeStatus.

IntegrationRuntimeType

IntegrationRuntimeType: "Managed" | "SelfHosted"

Defines values for IntegrationRuntimeType. Possible values include: 'Managed', 'SelfHosted'

readonly
enum

{string}

IntegrationRuntimeUnion

Contains the possible cases for IntegrationRuntime.

IntegrationRuntimeUpdateResult

IntegrationRuntimeUpdateResult: "None" | "Succeed" | "Fail"

Defines values for IntegrationRuntimeUpdateResult. Possible values include: 'None', 'Succeed', 'Fail'

readonly
enum

{string}

IntegrationRuntimesBeginStartResponse

IntegrationRuntimesBeginStartResponse: IntegrationRuntimeStatusResponse & object

Contains response data for the beginStart operation.

IntegrationRuntimesCreateLinkedIntegrationRuntimeResponse

IntegrationRuntimesCreateLinkedIntegrationRuntimeResponse: IntegrationRuntimeStatusResponse & object

Contains response data for the createLinkedIntegrationRuntime operation.

IntegrationRuntimesCreateOrUpdateResponse

IntegrationRuntimesCreateOrUpdateResponse: IntegrationRuntimeResource & object

Contains response data for the createOrUpdate operation.

IntegrationRuntimesGetConnectionInfoResponse

IntegrationRuntimesGetConnectionInfoResponse: IntegrationRuntimeConnectionInfo & object

Contains response data for the getConnectionInfo operation.

IntegrationRuntimesGetMonitoringDataResponse

IntegrationRuntimesGetMonitoringDataResponse: IntegrationRuntimeMonitoringData & object

Contains response data for the getMonitoringData operation.

IntegrationRuntimesGetResponse

IntegrationRuntimesGetResponse: IntegrationRuntimeResource & object

Contains response data for the get operation.

IntegrationRuntimesGetStatusResponse

IntegrationRuntimesGetStatusResponse: IntegrationRuntimeStatusResponse & object

Contains response data for the getStatus operation.

IntegrationRuntimesListAuthKeysResponse

IntegrationRuntimesListAuthKeysResponse: IntegrationRuntimeAuthKeys & object

Contains response data for the listAuthKeys operation.

IntegrationRuntimesListByFactoryNextResponse

IntegrationRuntimesListByFactoryNextResponse: IntegrationRuntimeListResponse & object

Contains response data for the listByFactoryNext operation.

IntegrationRuntimesListByFactoryResponse

IntegrationRuntimesListByFactoryResponse: IntegrationRuntimeListResponse & object

Contains response data for the listByFactory operation.

IntegrationRuntimesRegenerateAuthKeyResponse

IntegrationRuntimesRegenerateAuthKeyResponse: IntegrationRuntimeAuthKeys & object

Contains response data for the regenerateAuthKey operation.

IntegrationRuntimesStartResponse

IntegrationRuntimesStartResponse: IntegrationRuntimeStatusResponse & object

Contains response data for the start operation.

IntegrationRuntimesUpdateResponse

IntegrationRuntimesUpdateResponse: IntegrationRuntimeResource & object

Contains response data for the update operation.

JsonFormatFilePattern

JsonFormatFilePattern: "setOfObjects" | "arrayOfObjects"

Defines values for JsonFormatFilePattern. Possible values include: 'setOfObjects', 'arrayOfObjects'

readonly
enum

{string}

LinkedIntegrationRuntimeTypeUnion

Contains the possible cases for LinkedIntegrationRuntimeType.

LinkedServiceUnion

LinkedServiceUnion: LinkedService | ResponsysLinkedService | AzureDatabricksLinkedService | AzureDataLakeAnalyticsLinkedService | HDInsightOnDemandLinkedService | SalesforceMarketingCloudLinkedService | NetezzaLinkedService | VerticaLinkedService | ZohoLinkedService | XeroLinkedService | SquareLinkedService | SparkLinkedService | ShopifyLinkedService | ServiceNowLinkedService | QuickBooksLinkedService | PrestoLinkedService | PhoenixLinkedService | PaypalLinkedService | MarketoLinkedService | MariaDBLinkedService | MagentoLinkedService | JiraLinkedService | ImpalaLinkedService | HubspotLinkedService | HiveLinkedService | HBaseLinkedService | GreenplumLinkedService | GoogleBigQueryLinkedService | EloquaLinkedService | DrillLinkedService | CouchbaseLinkedService | ConcurLinkedService | AzurePostgreSqlLinkedService | AmazonMWSLinkedService | SapHanaLinkedService | SapBWLinkedService | SftpServerLinkedService | FtpServerLinkedService | HttpLinkedService | AzureSearchLinkedService | CustomDataSourceLinkedService | AmazonRedshiftLinkedService | AmazonS3LinkedService | SapEccLinkedService | SapCloudForCustomerLinkedService | SalesforceLinkedService | AzureDataLakeStoreLinkedService | MongoDbLinkedService | CassandraLinkedService | WebLinkedService | ODataLinkedService | HdfsLinkedService | OdbcLinkedService | AzureMLLinkedService | TeradataLinkedService | Db2LinkedService | SybaseLinkedService | PostgreSqlLinkedService | MySqlLinkedService | AzureMySqlLinkedService | OracleLinkedService | FileServerLinkedService | HDInsightLinkedService | DynamicsLinkedService | CosmosDbLinkedService | AzureKeyVaultLinkedService | AzureBatchLinkedService | AzureSqlDatabaseLinkedService | SqlServerLinkedService | AzureSqlDWLinkedService | AzureTableStorageLinkedService | AzureBlobStorageLinkedService | AzureStorageLinkedService

Contains the possible cases for LinkedService.

LinkedServicesCreateOrUpdateResponse

LinkedServicesCreateOrUpdateResponse: LinkedServiceResource & object

Contains response data for the createOrUpdate operation.

LinkedServicesGetResponse

LinkedServicesGetResponse: LinkedServiceResource & object

Contains response data for the get operation.

LinkedServicesListByFactoryNextResponse

LinkedServicesListByFactoryNextResponse: LinkedServiceListResponse & object

Contains response data for the listByFactoryNext operation.

LinkedServicesListByFactoryResponse

LinkedServicesListByFactoryResponse: LinkedServiceListResponse & object

Contains response data for the listByFactory operation.

ManagedIntegrationRuntimeNodeStatus

ManagedIntegrationRuntimeNodeStatus: "Starting" | "Available" | "Recycling" | "Unavailable"

Defines values for ManagedIntegrationRuntimeNodeStatus. Possible values include: 'Starting', 'Available', 'Recycling', 'Unavailable'

readonly
enum

{string}

MongoDbAuthenticationType

MongoDbAuthenticationType: "Basic" | "Anonymous"

Defines values for MongoDbAuthenticationType. Possible values include: 'Basic', 'Anonymous'

readonly
enum

{string}

MultiplePipelineTriggerUnion

Contains the possible cases for MultiplePipelineTrigger.

ODataAuthenticationType

ODataAuthenticationType: "Basic" | "Anonymous"

Defines values for ODataAuthenticationType. Possible values include: 'Basic', 'Anonymous'

readonly
enum

{string}

OperationsListNextResponse

OperationsListNextResponse: OperationListResponse & object

Contains response data for the listNext operation.

OperationsListResponse

OperationsListResponse: OperationListResponse & object

Contains response data for the list operation.

ParameterType

ParameterType: "Object" | "String" | "Int" | "Float" | "Bool" | "Array" | "SecureString"

Defines values for ParameterType. Possible values include: 'Object', 'String', 'Int', 'Float', 'Bool', 'Array', 'SecureString'

readonly
enum

{string}

PhoenixAuthenticationType

PhoenixAuthenticationType: "Anonymous" | "UsernameAndPassword" | "WindowsAzureHDInsightService"

Defines values for PhoenixAuthenticationType. Possible values include: 'Anonymous', 'UsernameAndPassword', 'WindowsAzureHDInsightService'

readonly
enum

{string}

PipelineRunsGetResponse

PipelineRunsGetResponse: PipelineRun & object

Contains response data for the get operation.

PipelineRunsQueryByFactoryResponse

PipelineRunsQueryByFactoryResponse: PipelineRunsQueryResponse & object

Contains response data for the queryByFactory operation.

PipelinesCreateOrUpdateResponse

PipelinesCreateOrUpdateResponse: PipelineResource & object

Contains response data for the createOrUpdate operation.

PipelinesCreateRunResponse

PipelinesCreateRunResponse: CreateRunResponse & object

Contains response data for the createRun operation.

PipelinesGetResponse

PipelinesGetResponse: PipelineResource & object

Contains response data for the get operation.

PipelinesListByFactoryNextResponse

PipelinesListByFactoryNextResponse: PipelineListResponse & object

Contains response data for the listByFactoryNext operation.

PipelinesListByFactoryResponse

PipelinesListByFactoryResponse: PipelineListResponse & object

Contains response data for the listByFactory operation.

PolybaseSettingsRejectType

PolybaseSettingsRejectType: "value" | "percentage"

Defines values for PolybaseSettingsRejectType. Possible values include: 'value', 'percentage'

readonly
enum

{string}

PrestoAuthenticationType

PrestoAuthenticationType: "Anonymous" | "LDAP"

Defines values for PrestoAuthenticationType. Possible values include: 'Anonymous', 'LDAP'

readonly
enum

{string}

RecurrenceFrequency

RecurrenceFrequency: "NotSpecified" | "Minute" | "Hour" | "Day" | "Week" | "Month" | "Year"

Defines values for RecurrenceFrequency. Possible values include: 'NotSpecified', 'Minute', 'Hour', 'Day', 'Week', 'Month', 'Year'

readonly
enum

{string}

RerunTriggersCreateResponse

RerunTriggersCreateResponse: TriggerResource & object

Contains response data for the create operation.

RerunTriggersListByTriggerNextResponse

RerunTriggersListByTriggerNextResponse: RerunTriggerListResponse & object

Contains response data for the listByTriggerNext operation.

RerunTriggersListByTriggerResponse

RerunTriggersListByTriggerResponse: RerunTriggerListResponse & object

Contains response data for the listByTrigger operation.

RunQueryFilterOperand

RunQueryFilterOperand: "PipelineName" | "Status" | "RunStart" | "RunEnd" | "ActivityName" | "ActivityRunStart" | "ActivityRunEnd" | "ActivityType" | "TriggerName" | "TriggerRunTimestamp"

Defines values for RunQueryFilterOperand. Possible values include: 'PipelineName', 'Status', 'RunStart', 'RunEnd', 'ActivityName', 'ActivityRunStart', 'ActivityRunEnd', 'ActivityType', 'TriggerName', 'TriggerRunTimestamp'

readonly
enum

{string}

RunQueryFilterOperator

RunQueryFilterOperator: "Equals" | "NotEquals" | "In" | "NotIn"

Defines values for RunQueryFilterOperator. Possible values include: 'Equals', 'NotEquals', 'In', 'NotIn'

readonly
enum

{string}

RunQueryOrder

RunQueryOrder: "ASC" | "DESC"

Defines values for RunQueryOrder. Possible values include: 'ASC', 'DESC'

readonly
enum

{string}

RunQueryOrderByField

RunQueryOrderByField: "RunStart" | "RunEnd" | "PipelineName" | "Status" | "ActivityName" | "ActivityRunStart" | "ActivityRunEnd" | "TriggerName" | "TriggerRunTimestamp"

Defines values for RunQueryOrderByField. Possible values include: 'RunStart', 'RunEnd', 'PipelineName', 'Status', 'ActivityName', 'ActivityRunStart', 'ActivityRunEnd', 'TriggerName', 'TriggerRunTimestamp'

readonly
enum

{string}

SSISExecutionRuntime

SSISExecutionRuntime: "x64" | "x86"

Defines values for SSISExecutionRuntime. Possible values include: 'x64', 'x86'

readonly
enum

{string}

SalesforceSinkWriteBehavior

SalesforceSinkWriteBehavior: "Insert" | "Upsert"

Defines values for SalesforceSinkWriteBehavior. Possible values include: 'Insert', 'Upsert'

readonly
enum

{string}

SalesforceSourceReadBehavior

SalesforceSourceReadBehavior: "Query" | "QueryAll"

Defines values for SalesforceSourceReadBehavior. Possible values include: 'Query', 'QueryAll'

readonly
enum

{string}

SapCloudForCustomerSinkWriteBehavior

SapCloudForCustomerSinkWriteBehavior: "Insert" | "Update"

Defines values for SapCloudForCustomerSinkWriteBehavior. Possible values include: 'Insert', 'Update'

readonly
enum

{string}

SapHanaAuthenticationType

SapHanaAuthenticationType: "Basic" | "Windows"

Defines values for SapHanaAuthenticationType. Possible values include: 'Basic', 'Windows'

readonly
enum

{string}

SecretBaseUnion

Contains the possible cases for SecretBase.

SelfHostedIntegrationRuntimeNodeStatus

SelfHostedIntegrationRuntimeNodeStatus: "NeedRegistration" | "Online" | "Limited" | "Offline" | "Upgrading" | "Initializing" | "InitializeFailed"

Defines values for SelfHostedIntegrationRuntimeNodeStatus. Possible values include: 'NeedRegistration', 'Online', 'Limited', 'Offline', 'Upgrading', 'Initializing', 'InitializeFailed'

readonly
enum

{string}

ServiceNowAuthenticationType

ServiceNowAuthenticationType: "Basic" | "OAuth2"

Defines values for ServiceNowAuthenticationType. Possible values include: 'Basic', 'OAuth2'

readonly
enum

{string}

SftpAuthenticationType

SftpAuthenticationType: "Basic" | "SshPublicKey"

Defines values for SftpAuthenticationType. Possible values include: 'Basic', 'SshPublicKey'

readonly
enum

{string}

SparkAuthenticationType

SparkAuthenticationType: "Anonymous" | "Username" | "UsernameAndPassword" | "WindowsAzureHDInsightService"

Defines values for SparkAuthenticationType. Possible values include: 'Anonymous', 'Username', 'UsernameAndPassword', 'WindowsAzureHDInsightService'

readonly
enum

{string}

SparkServerType

SparkServerType: "SharkServer" | "SharkServer2" | "SparkThriftServer"

Defines values for SparkServerType. Possible values include: 'SharkServer', 'SharkServer2', 'SparkThriftServer'

readonly
enum

{string}

SparkThriftTransportProtocol

SparkThriftTransportProtocol: "Binary" | "SASL" | "HTTP "

Defines values for SparkThriftTransportProtocol. Possible values include: 'Binary', 'SASL', 'HTTP '

readonly
enum

{string}

StoredProcedureParameterType

StoredProcedureParameterType: "String" | "Int" | "Decimal" | "Guid" | "Boolean" | "Date"

Defines values for StoredProcedureParameterType. Possible values include: 'String', 'Int', 'Decimal', 'Guid', 'Boolean', 'Date'

readonly
enum

{string}

SybaseAuthenticationType

SybaseAuthenticationType: "Basic" | "Windows"

Defines values for SybaseAuthenticationType. Possible values include: 'Basic', 'Windows'

readonly
enum

{string}

TeradataAuthenticationType

TeradataAuthenticationType: "Basic" | "Windows"

Defines values for TeradataAuthenticationType. Possible values include: 'Basic', 'Windows'

readonly
enum

{string}

TriggerDependencyReferenceUnion

Contains the possible cases for TriggerDependencyReference.

TriggerRunStatus

TriggerRunStatus: "Succeeded" | "Failed" | "Inprogress"

Defines values for TriggerRunStatus. Possible values include: 'Succeeded', 'Failed', 'Inprogress'

readonly
enum

{string}

TriggerRunsQueryByFactoryResponse

TriggerRunsQueryByFactoryResponse: TriggerRunsQueryResponse & object

Contains response data for the queryByFactory operation.

TriggerRuntimeState

TriggerRuntimeState: "Started" | "Stopped" | "Disabled"

Defines values for TriggerRuntimeState. Possible values include: 'Started', 'Stopped', 'Disabled'

readonly
enum

{string}

TriggerUnion

Contains the possible cases for Trigger.

TriggersCreateOrUpdateResponse

TriggersCreateOrUpdateResponse: TriggerResource & object

Contains response data for the createOrUpdate operation.

TriggersGetResponse

TriggersGetResponse: TriggerResource & object

Contains response data for the get operation.

TriggersListByFactoryNextResponse

TriggersListByFactoryNextResponse: TriggerListResponse & object

Contains response data for the listByFactoryNext operation.

TriggersListByFactoryResponse

TriggersListByFactoryResponse: TriggerListResponse & object

Contains response data for the listByFactory operation.

TumblingWindowFrequency

TumblingWindowFrequency: "Minute" | "Hour"

Defines values for TumblingWindowFrequency. Possible values include: 'Minute', 'Hour'

readonly
enum

{string}

VariableType

VariableType: "String" | "Bool" | "Array"

Defines values for VariableType. Possible values include: 'String', 'Bool', 'Array'

readonly
enum

{string}

WebActivityMethod

WebActivityMethod: "GET" | "POST" | "PUT" | "DELETE"

Defines values for WebActivityMethod. Possible values include: 'GET', 'POST', 'PUT', 'DELETE'

readonly
enum

{string}

WebLinkedServiceTypePropertiesUnion

Contains the possible cases for WebLinkedServiceTypeProperties.

Variables

Const BaseResource

BaseResource: CompositeMapper = BaseResourceMapper

Const CloudError

CloudError: CompositeMapper = CloudErrorMapper

Object literals

Const Activity

Activity: object
interface

An interface representing Activity. A pipeline activity.

Optional dependsOn

dependsOn: ActivityDependency[]
member

{ActivityDependency[]} [dependsOn] Activity depends on condition.

Optional description

description: undefined | string
member

{string} [description] Activity description.

name

name: string
member

{string} name Activity name.

Optional userProperties

userProperties: UserProperty[]
member

{UserProperty[]} [userProperties] Activity user properties.

serializedName

serializedName: string = "Activity"

type

type: object
member

{string} type Polymorphic Discriminator

className

className: string = "Activity"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "Activity"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

modelProperties

modelProperties: object

dependsOn

dependsOn: object

serializedName

serializedName: string = "dependsOn"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ActivityDependency"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

type

type: object

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

userProperties

userProperties: object

serializedName

serializedName: string = "userProperties"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "UserProperty"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "type"

serializedName

serializedName: string = "type"

Const ActivityDependency

ActivityDependency: object
interface

An interface representing ActivityDependency. Activity dependency information.

activity

activity: string
member

{string} activity Activity name.

dependencyConditions

dependencyConditions: DependencyCondition[]
member

{DependencyCondition[]} dependencyConditions Match-Condition for the dependency.

serializedName

serializedName: string = "ActivityDependency"

type

type: object

className

className: string = "ActivityDependency"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

modelProperties

modelProperties: object

activity

activity: object

required

required: true = true

serializedName

serializedName: string = "activity"

type

type: object

name

name: "String" = "String"

dependencyConditions

dependencyConditions: object

required

required: true = true

serializedName

serializedName: string = "dependencyConditions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const ActivityPolicy

ActivityPolicy: object
interface

An interface representing ActivityPolicy. Execution policy for an activity.

Optional retry

retry: any
member

{any} [retry] Maximum ordinary retry attempts. Default is 0. Type: integer (or Expression with resultType integer), minimum: 0.

Optional retryIntervalInSeconds

retryIntervalInSeconds: undefined | number
member

{number} [retryIntervalInSeconds] Interval between each retry attempt (in seconds). The default is 30 sec.

Optional secureInput

secureInput: undefined | false | true
member

{boolean} [secureInput] When set to true, Input from activity is considered as secure and will not be logged to monitoring.

Optional secureOutput

secureOutput: undefined | false | true
member

{boolean} [secureOutput] When set to true, Output from activity is considered as secure and will not be logged to monitoring.

Optional timeout

timeout: any
member

{any} [timeout] Specifies the timeout for the activity to run. The default timeout is 7 days. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "ActivityPolicy"

type

type: object

className

className: string = "ActivityPolicy"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

modelProperties

modelProperties: object

retry

retry: object

serializedName

serializedName: string = "retry"

type

type: object

name

name: "Object" = "Object"

retryIntervalInSeconds

retryIntervalInSeconds: object

serializedName

serializedName: string = "retryIntervalInSeconds"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 86400

InclusiveMinimum

InclusiveMinimum: number = 30

type

type: object

name

name: "Number" = "Number"

secureInput

secureInput: object

serializedName

serializedName: string = "secureInput"

type

type: object

name

name: "Boolean" = "Boolean"

secureOutput

secureOutput: object

serializedName

serializedName: string = "secureOutput"

type

type: object

name

name: "Boolean" = "Boolean"

timeout

timeout: object

serializedName

serializedName: string = "timeout"

type

type: object

name

name: "Object" = "Object"

Const ActivityRun

ActivityRun: object
interface

An interface representing ActivityRun. Information about an activity run in a pipeline.

Optional activityName

activityName: undefined | string
member

{string} [activityName] The name of the activity. NOTE: This property will not be serialized. It can only be populated by the server.

Optional activityRunEnd

activityRunEnd: Date
member

{Date} [activityRunEnd] The end time of the activity run in 'ISO 8601' format. NOTE: This property will not be serialized. It can only be populated by the server.

Optional activityRunId

activityRunId: undefined | string
member

{string} [activityRunId] The id of the activity run. NOTE: This property will not be serialized. It can only be populated by the server.

Optional activityRunStart

activityRunStart: Date
member

{Date} [activityRunStart] The start time of the activity run in 'ISO 8601' format. NOTE: This property will not be serialized. It can only be populated by the server.

Optional activityType

activityType: undefined | string
member

{string} [activityType] The type of the activity. NOTE: This property will not be serialized. It can only be populated by the server.

Optional durationInMs

durationInMs: undefined | number
member

{number} [durationInMs] The duration of the activity run. NOTE: This property will not be serialized. It can only be populated by the server.

Optional error

error: any
member

{any} [error] The error if any from the activity run. NOTE: This property will not be serialized. It can only be populated by the server.

Optional input

input: any
member

{any} [input] The input for the activity. NOTE: This property will not be serialized. It can only be populated by the server.

Optional linkedServiceName

linkedServiceName: undefined | string
member

{string} [linkedServiceName] The name of the compute linked service. NOTE: This property will not be serialized. It can only be populated by the server.

Optional output

output: any
member

{any} [output] The output for the activity. NOTE: This property will not be serialized. It can only be populated by the server.

Optional pipelineName

pipelineName: undefined | string
member

{string} [pipelineName] The name of the pipeline. NOTE: This property will not be serialized. It can only be populated by the server.

Optional pipelineRunId

pipelineRunId: undefined | string
member

{string} [pipelineRunId] The id of the pipeline run. NOTE: This property will not be serialized. It can only be populated by the server.

Optional status

status: undefined | string
member

{string} [status] The status of the activity run. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ActivityRun"

type

type: object

className

className: string = "ActivityRun"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

modelProperties

modelProperties: object

activityName

activityName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "activityName"

type

type: object

name

name: "String" = "String"

activityRunEnd

activityRunEnd: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "activityRunEnd"

type

type: object

name

name: "DateTime" = "DateTime"

activityRunId

activityRunId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "activityRunId"

type

type: object

name

name: "String" = "String"

activityRunStart

activityRunStart: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "activityRunStart"

type

type: object

name

name: "DateTime" = "DateTime"

activityType

activityType: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "activityType"

type

type: object

name

name: "String" = "String"

durationInMs

durationInMs: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "durationInMs"

type

type: object

name

name: "Number" = "Number"

error

error: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "error"

type

type: object

name

name: "Object" = "Object"

input

input: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "input"

type

type: object

name

name: "Object" = "Object"

linkedServiceName

linkedServiceName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "linkedServiceName"

type

type: object

name

name: "String" = "String"

output

output: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "output"

type

type: object

name

name: "Object" = "Object"

pipelineName

pipelineName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "pipelineName"

type

type: object

name

name: "String" = "String"

pipelineRunId

pipelineRunId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "pipelineRunId"

type

type: object

name

name: "String" = "String"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

Const ActivityRunsQueryResponse

ActivityRunsQueryResponse: object
interface

An interface representing ActivityRunsQueryResponse. A list activity runs.

Optional continuationToken

continuationToken: undefined | string
member

{string} [continuationToken] The continuation token for getting the next page of results, if any remaining results exist, null otherwise.

value

value: ActivityRun[]
member

{ActivityRun[]} value List of activity runs.

serializedName

serializedName: string = "ActivityRunsQueryResponse"

type

type: object

className

className: string = "ActivityRunsQueryResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

continuationToken

continuationToken: object

serializedName

serializedName: string = "continuationToken"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ActivityRun"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

Const AmazonMWSLinkedService

AmazonMWSLinkedService: object
interface

An interface representing AmazonMWSLinkedService. Amazon Marketplace Web Service linked service.

accessKeyId

accessKeyId: any
member

{any} accessKeyId The access key id used to access data.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

endpoint

endpoint: any
member

{any} endpoint The endpoint of the Amazon MWS server, (i.e. mws.amazonservices.com)

marketplaceID

marketplaceID: any
member

{any} marketplaceID The Amazon Marketplace ID you want to retrieve data from. To retrive data from multiple Marketplace IDs, seperate them with a comma (,). (i.e. A2EUQ1WTGCTBG2)

Optional mwsAuthToken

mwsAuthToken: SecretBaseUnion
member

{SecretBaseUnion} [mwsAuthToken] The Amazon MWS authentication token.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional secretKey

secretKey: SecretBaseUnion
member

{SecretBaseUnion} [secretKey] The secret key used to access data.

sellerID

sellerID: any
member

{any} sellerID The Amazon seller ID.

Optional useEncryptedEndpoints

useEncryptedEndpoints: any
member

{any} [useEncryptedEndpoints] Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

Optional useHostVerification

useHostVerification: any
member

{any} [useHostVerification] Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.

Optional usePeerVerification

usePeerVerification: any
member

{any} [usePeerVerification] Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

serializedName

serializedName: string = "AmazonMWS"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "AmazonMWSLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

accessKeyId

accessKeyId: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.accessKeyId"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

endpoint

endpoint: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.endpoint"

type

type: object

name

name: "Object" = "Object"

marketplaceID

marketplaceID: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.marketplaceID"

type

type: object

name

name: "Object" = "Object"

mwsAuthToken

mwsAuthToken: object

serializedName

serializedName: string = "typeProperties.mwsAuthToken"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

secretKey

secretKey: object

serializedName

serializedName: string = "typeProperties.secretKey"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

sellerID

sellerID: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.sellerID"

type

type: object

name

name: "Object" = "Object"

useEncryptedEndpoints

useEncryptedEndpoints: object

serializedName

serializedName: string = "typeProperties.useEncryptedEndpoints"

type

type: object

name

name: "Object" = "Object"

useHostVerification

useHostVerification: object

serializedName

serializedName: string = "typeProperties.useHostVerification"

type

type: object

name

name: "Object" = "Object"

usePeerVerification

usePeerVerification: object

serializedName

serializedName: string = "typeProperties.usePeerVerification"

type

type: object

name

name: "Object" = "Object"

Const AmazonMWSObjectDataset

AmazonMWSObjectDataset: object
interface

An interface representing AmazonMWSObjectDataset. Amazon Marketplace Web Service dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Optional tableName

tableName: any
member

{any} [tableName] The table name. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "AmazonMWSObject"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "AmazonMWSObjectDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

tableName

tableName: object

serializedName

serializedName: string = "typeProperties.tableName"

type

type: object

name

name: "Object" = "Object"

Const AmazonMWSSource

AmazonMWSSource: object
interface

An interface representing AmazonMWSSource. A copy activity Amazon Marketplace Web Service source.

Optional query

query: any
member

{any} [query] A query to retrieve data from source. Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "AmazonMWSSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "AmazonMWSSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

Const AmazonRedshiftLinkedService

AmazonRedshiftLinkedService: object
interface

An interface representing AmazonRedshiftLinkedService. Linked service for Amazon Redshift.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

database

database: any
member

{any} database The database name of the Amazon Redshift source. Type: string (or Expression with resultType string).

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional password

password: SecretBaseUnion
member

{SecretBaseUnion} [password] The password of the Amazon Redshift source.

Optional port

port: any
member

{any} [port] The TCP port number that the Amazon Redshift server uses to listen for client connections. The default value is 5439. Type: integer (or Expression with resultType integer).

server

server: any
member

{any} server The name of the Amazon Redshift server. Type: string (or Expression with resultType string).

Optional username

username: any
member

{any} [username] The username of the Amazon Redshift source. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "AmazonRedshift"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "AmazonRedshiftLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

database

database: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.database"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

password

password: object

serializedName

serializedName: string = "typeProperties.password"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

port

port: object

serializedName

serializedName: string = "typeProperties.port"

type

type: object

name

name: "Object" = "Object"

server

server: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.server"

type

type: object

name

name: "Object" = "Object"

username

username: object

serializedName

serializedName: string = "typeProperties.username"

type

type: object

name

name: "Object" = "Object"

Const AmazonRedshiftSource

AmazonRedshiftSource: object
interface

An interface representing AmazonRedshiftSource. A copy activity source for Amazon Redshift Source.

Optional query

query: any
member

{any} [query] Database query. Type: string (or Expression with resultType string).

Optional redshiftUnloadSettings

redshiftUnloadSettings: RedshiftUnloadSettings
member

{RedshiftUnloadSettings} [redshiftUnloadSettings] The Amazon S3 settings needed for the interim Amazon S3 when copying from Amazon Redshift with unload. With this, data from Amazon Redshift source will be unloaded into S3 first and then copied into the targeted sink from the interim S3.

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "AmazonRedshiftSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "AmazonRedshiftSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

redshiftUnloadSettings

redshiftUnloadSettings: object

serializedName

serializedName: string = "redshiftUnloadSettings"

type

type: object

className

className: string = "RedshiftUnloadSettings"

name

name: "Composite" = "Composite"

Const AmazonS3Dataset

AmazonS3Dataset: object
interface

An interface representing AmazonS3Dataset. A single Amazon Simple Storage Service (S3) object or a set of S3 objects.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

bucketName

bucketName: any
member

{any} bucketName The name of the Amazon S3 bucket. Type: string (or Expression with resultType string).

Optional compression

member

{DatasetCompressionUnion} [compression] The data compression method used for the Amazon S3 object.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

Optional format

member

{DatasetStorageFormatUnion} [format] The format of files.

Optional key

key: any
member

{any} [key] The key of the Amazon S3 object. Type: string (or Expression with resultType string).

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional prefix

prefix: any
member

{any} [prefix] The prefix filter for the S3 object name. Type: string (or Expression with resultType string).

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Optional version

version: any
member

{any} [version] The version for the S3 object. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "AmazonS3Object"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "AmazonS3Dataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

bucketName

bucketName: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.bucketName"

type

type: object

name

name: "Object" = "Object"

compression

compression: object

serializedName

serializedName: string = "typeProperties.compression"

type

type: object

className

className: string = "DatasetCompression"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

format

format: object

serializedName

serializedName: string = "typeProperties.format"

type

type: object

className

className: string = "DatasetStorageFormat"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

key

key: object

serializedName

serializedName: string = "typeProperties.key"

type

type: object

name

name: "Object" = "Object"

prefix

prefix: object

serializedName

serializedName: string = "typeProperties.prefix"

type

type: object

name

name: "Object" = "Object"

version

version: object

serializedName

serializedName: string = "typeProperties.version"

type

type: object

name

name: "Object" = "Object"

Const AmazonS3LinkedService

AmazonS3LinkedService: object
interface

An interface representing AmazonS3LinkedService. Linked service for Amazon S3.

Optional accessKeyId

accessKeyId: any
member

{any} [accessKeyId] The access key identifier of the Amazon S3 Identity and Access Management (IAM) user. Type: string (or Expression with resultType string).

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional secretAccessKey

secretAccessKey: SecretBaseUnion
member

{SecretBaseUnion} [secretAccessKey] The secret access key of the Amazon S3 Identity and Access Management (IAM) user.

serializedName

serializedName: string = "AmazonS3"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "AmazonS3LinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

accessKeyId

accessKeyId: object

serializedName

serializedName: string = "typeProperties.accessKeyId"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

secretAccessKey

secretAccessKey: object

serializedName

serializedName: string = "typeProperties.secretAccessKey"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

Const AppendVariableActivity

AppendVariableActivity: object
interface

An interface representing AppendVariableActivity. Append value for a Variable of type Array.

Optional dependsOn

dependsOn: ActivityDependency[]
member

{ActivityDependency[]} [dependsOn] Activity depends on condition.

Optional description

description: undefined | string
member

{string} [description] Activity description.

name

name: string
member

{string} name Activity name.

Optional userProperties

userProperties: UserProperty[]
member

{UserProperty[]} [userProperties] Activity user properties.

Optional value

value: any
member

{any} [value] Value to be appended. Could be a static value or Expression

Optional variableName

variableName: undefined | string
member

{string} [variableName] Name of the variable whose value needs to be appended to.

serializedName

serializedName: string = "AppendVariable"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Activity.type.additionalProperties

className

className: string = "AppendVariableActivity"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Activity.type.polymorphicDiscriminator

uberParent

uberParent: string = "Activity"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = "typeProperties.value"

type

type: object

name

name: "Object" = "Object"

variableName

variableName: object

serializedName

serializedName: string = "typeProperties.variableName"

type

type: object

name

name: "String" = "String"

Const AvroFormat

AvroFormat: object
interface

An interface representing AvroFormat. The data stored in Avro format.

Optional deserializer

deserializer: any
member

{any} [deserializer] Deserializer. Type: string (or Expression with resultType string).

Optional serializer

serializer: any
member

{any} [serializer] Serializer. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "AvroFormat"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = DatasetStorageFormat.type.additionalProperties

className

className: string = "AvroFormat"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = DatasetStorageFormat.type.polymorphicDiscriminator

uberParent

uberParent: string = "DatasetStorageFormat"

modelProperties

modelProperties: object

Const AzureBatchLinkedService

AzureBatchLinkedService: object
interface

An interface representing AzureBatchLinkedService. Azure Batch linked service.

Optional accessKey

accessKey: SecretBaseUnion
member

{SecretBaseUnion} [accessKey] The Azure Batch account access key.

accountName

accountName: any
member

{any} accountName The Azure Batch account name. Type: string (or Expression with resultType string).

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

batchUri

batchUri: any
member

{any} batchUri The Azure Batch URI. Type: string (or Expression with resultType string).

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName The Azure Storage linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

poolName

poolName: any
member

{any} poolName The Azure Batch pool name. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "AzureBatch"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "AzureBatchLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

accessKey

accessKey: object

serializedName

serializedName: string = "typeProperties.accessKey"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

accountName

accountName: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.accountName"

type

type: object

name

name: "Object" = "Object"

batchUri

batchUri: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.batchUri"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

linkedServiceName

linkedServiceName: object

defaultValue

defaultValue: object

Type declaration

required

required: true = true

serializedName

serializedName: string = "typeProperties.linkedServiceName"

type

type: object

className

className: string = "LinkedServiceReference"

name

name: "Composite" = "Composite"

poolName

poolName: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.poolName"

type

type: object

name

name: "Object" = "Object"

Const AzureBlobDataset

AzureBlobDataset: object
interface

An interface representing AzureBlobDataset. The Azure Blob storage.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional compression

member

{DatasetCompressionUnion} [compression] The data compression method used for the blob storage.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional fileName

fileName: any
member

{any} [fileName] The name of the Azure Blob. Type: string (or Expression with resultType string).

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

Optional folderPath

folderPath: any
member

{any} [folderPath] The path of the Azure Blob storage. Type: string (or Expression with resultType string).

Optional format

member

{DatasetStorageFormatUnion} [format] The format of the Azure Blob storage.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Optional tableRootLocation

tableRootLocation: any
member

{any} [tableRootLocation] The root of blob path. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "AzureBlob"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "AzureBlobDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

compression

compression: object

serializedName

serializedName: string = "typeProperties.compression"

type

type: object

className

className: string = "DatasetCompression"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

fileName

fileName: object

serializedName

serializedName: string = "typeProperties.fileName"

type

type: object

name

name: "Object" = "Object"

folderPath

folderPath: object

serializedName

serializedName: string = "typeProperties.folderPath"

type

type: object

name

name: "Object" = "Object"

format

format: object

serializedName

serializedName: string = "typeProperties.format"

type

type: object

className

className: string = "DatasetStorageFormat"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

tableRootLocation

tableRootLocation: object

serializedName

serializedName: string = "typeProperties.tableRootLocation"

type

type: object

name

name: "Object" = "Object"

Const AzureBlobStorageLinkedService

AzureBlobStorageLinkedService: object
interface

An interface representing AzureBlobStorageLinkedService. The azure blob storage linked service.

Optional accountKey

member

{AzureKeyVaultSecretReference} [accountKey] The Azure key vault secret reference of accountKey in connection string.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional connectionString

connectionString: any
member

{any} [connectionString] The connection string. It is mutually exclusive with sasUri, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: undefined | string
member

{string} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional sasToken

member

{AzureKeyVaultSecretReference} [sasToken] The Azure key vault secret reference of sasToken in sas uri.

Optional sasUri

sasUri: any
member

{any} [sasUri] SAS URI of the Azure Blob Storage resource. It is mutually exclusive with connectionString, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference.

Optional serviceEndpoint

serviceEndpoint: undefined | string
member

{string} [serviceEndpoint] Blob service endpoint of the Azure Blob Storage resource. It is mutually exclusive with connectionString, sasUri property.

Optional servicePrincipalId

servicePrincipalId: any
member

{any} [servicePrincipalId] The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string).

Optional servicePrincipalKey

servicePrincipalKey: SecretBaseUnion
member

{SecretBaseUnion} [servicePrincipalKey] The key of the service principal used to authenticate against Azure SQL Data Warehouse.

Optional tenant

tenant: any
member

{any} [tenant] The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "AzureBlobStorage"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "AzureBlobStorageLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

accountKey

accountKey: object

serializedName

serializedName: string = "typeProperties.accountKey"

type

type: object

className

className: string = "AzureKeyVaultSecretReference"

name

name: "Composite" = "Composite"

connectionString

connectionString: object

serializedName

serializedName: string = "typeProperties.connectionString"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "String" = "String"

sasToken

sasToken: object

serializedName

serializedName: string = "typeProperties.sasToken"

type

type: object

className

className: string = "AzureKeyVaultSecretReference"

name

name: "Composite" = "Composite"

sasUri

sasUri: object

serializedName

serializedName: string = "typeProperties.sasUri"

type

type: object

name

name: "Object" = "Object"

serviceEndpoint

serviceEndpoint: object

serializedName

serializedName: string = "typeProperties.serviceEndpoint"

type

type: object

name

name: "String" = "String"

servicePrincipalId

servicePrincipalId: object

serializedName

serializedName: string = "typeProperties.servicePrincipalId"

type

type: object

name

name: "Object" = "Object"

servicePrincipalKey

servicePrincipalKey: object

serializedName

serializedName: string = "typeProperties.servicePrincipalKey"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

tenant

tenant: object

serializedName

serializedName: string = "typeProperties.tenant"

type

type: object

name

name: "Object" = "Object"

Const AzureDataLakeAnalyticsLinkedService

AzureDataLakeAnalyticsLinkedService: object
interface

An interface representing AzureDataLakeAnalyticsLinkedService. Azure Data Lake Analytics linked service.

accountName

accountName: any
member

{any} accountName The Azure Data Lake Analytics account name. Type: string (or Expression with resultType string).

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional dataLakeAnalyticsUri

dataLakeAnalyticsUri: any
member

{any} [dataLakeAnalyticsUri] Azure Data Lake Analytics URI Type: string (or Expression with resultType string).

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional resourceGroupName

resourceGroupName: any
member

{any} [resourceGroupName] Data Lake Analytics account resource group name (if different from Data Factory account). Type: string (or Expression with resultType string).

Optional servicePrincipalId

servicePrincipalId: any
member

{any} [servicePrincipalId] The ID of the application used to authenticate against the Azure Data Lake Analytics account. Type: string (or Expression with resultType string).

Optional servicePrincipalKey

servicePrincipalKey: SecretBaseUnion
member

{SecretBaseUnion} [servicePrincipalKey] The Key of the application used to authenticate against the Azure Data Lake Analytics account.

Optional subscriptionId

subscriptionId: any
member

{any} [subscriptionId] Data Lake Analytics account subscription ID (if different from Data Factory account). Type: string (or Expression with resultType string).

tenant

tenant: any
member

{any} tenant The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "AzureDataLakeAnalytics"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "AzureDataLakeAnalyticsLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

accountName

accountName: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.accountName"

type

type: object

name

name: "Object" = "Object"

dataLakeAnalyticsUri

dataLakeAnalyticsUri: object

serializedName

serializedName: string = "typeProperties.dataLakeAnalyticsUri"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

resourceGroupName

resourceGroupName: object

serializedName

serializedName: string = "typeProperties.resourceGroupName"

type

type: object

name

name: "Object" = "Object"

servicePrincipalId

servicePrincipalId: object

serializedName

serializedName: string = "typeProperties.servicePrincipalId"

type

type: object

name

name: "Object" = "Object"

servicePrincipalKey

servicePrincipalKey: object

serializedName

serializedName: string = "typeProperties.servicePrincipalKey"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

subscriptionId

subscriptionId: object

serializedName

serializedName: string = "typeProperties.subscriptionId"

type

type: object

name

name: "Object" = "Object"

tenant

tenant: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.tenant"

type

type: object

name

name: "Object" = "Object"

Const AzureDataLakeStoreDataset

AzureDataLakeStoreDataset: object
interface

An interface representing AzureDataLakeStoreDataset. Azure Data Lake Store dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional compression

member

{DatasetCompressionUnion} [compression] The data compression method used for the item(s) in the Azure Data Lake Store.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional fileName

fileName: any
member

{any} [fileName] The name of the file in the Azure Data Lake Store. Type: string (or Expression with resultType string).

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

folderPath

folderPath: any
member

{any} folderPath Path to the folder in the Azure Data Lake Store. Type: string (or Expression with resultType string).

Optional format

member

{DatasetStorageFormatUnion} [format] The format of the Data Lake Store.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

serializedName

serializedName: string = "AzureDataLakeStoreFile"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "AzureDataLakeStoreDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

compression

compression: object

serializedName

serializedName: string = "typeProperties.compression"

type

type: object

className

className: string = "DatasetCompression"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

fileName

fileName: object

serializedName

serializedName: string = "typeProperties.fileName"

type

type: object

name

name: "Object" = "Object"

folderPath

folderPath: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.folderPath"

type

type: object

name

name: "Object" = "Object"

format

format: object

serializedName

serializedName: string = "typeProperties.format"

type

type: object

className

className: string = "DatasetStorageFormat"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

Const AzureDataLakeStoreLinkedService

AzureDataLakeStoreLinkedService: object
interface

An interface representing AzureDataLakeStoreLinkedService. Azure Data Lake Store linked service.

Optional accountName

accountName: any
member

{any} [accountName] Data Lake Store account name. Type: string (or Expression with resultType string).

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

dataLakeStoreUri

dataLakeStoreUri: any
member

{any} dataLakeStoreUri Data Lake Store service URI. Type: string (or Expression with resultType string).

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional resourceGroupName

resourceGroupName: any
member

{any} [resourceGroupName] Data Lake Store account resource group name (if different from Data Factory account). Type: string (or Expression with resultType string).

Optional servicePrincipalId

servicePrincipalId: any
member

{any} [servicePrincipalId] The ID of the application used to authenticate against the Azure Data Lake Store account. Type: string (or Expression with resultType string).

Optional servicePrincipalKey

servicePrincipalKey: SecretBaseUnion
member

{SecretBaseUnion} [servicePrincipalKey] The Key of the application used to authenticate against the Azure Data Lake Store account.

Optional subscriptionId

subscriptionId: any
member

{any} [subscriptionId] Data Lake Store account subscription ID (if different from Data Factory account). Type: string (or Expression with resultType string).

Optional tenant

tenant: any
member

{any} [tenant] The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "AzureDataLakeStore"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "AzureDataLakeStoreLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

accountName

accountName: object

serializedName

serializedName: string = "typeProperties.accountName"

type

type: object

name

name: "Object" = "Object"

dataLakeStoreUri

dataLakeStoreUri: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.dataLakeStoreUri"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

resourceGroupName

resourceGroupName: object

serializedName

serializedName: string = "typeProperties.resourceGroupName"

type

type: object

name

name: "Object" = "Object"

servicePrincipalId

servicePrincipalId: object

serializedName

serializedName: string = "typeProperties.servicePrincipalId"

type

type: object

name

name: "Object" = "Object"

servicePrincipalKey

servicePrincipalKey: object

serializedName

serializedName: string = "typeProperties.servicePrincipalKey"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

subscriptionId

subscriptionId: object

serializedName

serializedName: string = "typeProperties.subscriptionId"

type

type: object

name

name: "Object" = "Object"

tenant

tenant: object

serializedName

serializedName: string = "typeProperties.tenant"

type

type: object

name

name: "Object" = "Object"

Const AzureDataLakeStoreSink

AzureDataLakeStoreSink: object
interface

An interface representing AzureDataLakeStoreSink. A copy activity Azure Data Lake Store sink.

Optional copyBehavior

copyBehavior: CopyBehaviorType
member

{CopyBehaviorType} [copyBehavior] The type of copy behavior for copy sink. Possible values include: 'PreserveHierarchy', 'FlattenHierarchy', 'MergeFiles'

Optional sinkRetryCount

sinkRetryCount: any
member

{any} [sinkRetryCount] Sink retry count. Type: integer (or Expression with resultType integer).

Optional sinkRetryWait

sinkRetryWait: any
member

{any} [sinkRetryWait] Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Optional writeBatchSize

writeBatchSize: any
member

{any} [writeBatchSize] Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

Optional writeBatchTimeout

writeBatchTimeout: any
member

{any} [writeBatchTimeout] Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "AzureDataLakeStoreSink"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySink.type.additionalProperties

className

className: string = "AzureDataLakeStoreSink"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySink.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySink"

modelProperties

modelProperties: object

copyBehavior

copyBehavior: object

serializedName

serializedName: string = "copyBehavior"

type

type: object

name

name: "String" = "String"

Const AzureDataLakeStoreSource

AzureDataLakeStoreSource: object
interface

An interface representing AzureDataLakeStoreSource. A copy activity Azure Data Lake source.

Optional recursive

recursive: any
member

{any} [recursive] If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "AzureDataLakeStoreSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "AzureDataLakeStoreSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

recursive

recursive: object

serializedName

serializedName: string = "recursive"

type

type: object

name

name: "Object" = "Object"

Const AzureDatabricksLinkedService

AzureDatabricksLinkedService: object
interface

An interface representing AzureDatabricksLinkedService. Azure Databricks linked service.

accessToken

accessToken: SecretBaseUnion
member

{SecretBaseUnion} accessToken Access token for databricks REST API. Refer to https://docs.azuredatabricks.net/api/latest/authentication.html. Type: string (or Expression with resultType string).

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

domain

domain: any
member

{any} domain .azuredatabricks.net, domain name of your Databricks deployment. Type: string (or Expression with resultType string).

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional existingClusterId

existingClusterId: any
member

{any} [existingClusterId] The id of an existing cluster that will be used for all runs of this job. Type: string (or Expression with resultType string).

Optional newClusterCustomTags

newClusterCustomTags: undefined | object
member

{{ [propertyName: string]: any }} [newClusterCustomTags] Additional tags for cluster resources.

Optional newClusterNodeType

newClusterNodeType: any
member

{any} [newClusterNodeType] The node types of new cluster. Type: string (or Expression with resultType string).

Optional newClusterNumOfWorker

newClusterNumOfWorker: any
member

{any} [newClusterNumOfWorker] Number of worker nodes that new cluster should have. A string formatted Int32, like '1' means numOfWorker is 1 or '1:10' means auto-scale from 1 as min and 10 as max. Type: string (or Expression with resultType string).

Optional newClusterSparkConf

newClusterSparkConf: undefined | object
member

{{ [propertyName: string]: any }} [newClusterSparkConf] A set of optional, user-specified Spark configuration key-value pairs.

Optional newClusterSparkEnvVars

newClusterSparkEnvVars: undefined | object
member

{{ [propertyName: string]: any }} [newClusterSparkEnvVars] A set of optional, user-specified Spark environment variables key-value pairs.

Optional newClusterVersion

newClusterVersion: any
member

{any} [newClusterVersion] The Spark version of new cluster. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

serializedName

serializedName: string = "AzureDatabricks"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "AzureDatabricksLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

accessToken

accessToken: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.accessToken"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

domain

domain: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.domain"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

existingClusterId

existingClusterId: object

serializedName

serializedName: string = "typeProperties.existingClusterId"

type

type: object

name

name: "Object" = "Object"

newClusterCustomTags

newClusterCustomTags: object

serializedName

serializedName: string = "typeProperties.newClusterCustomTags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Object" = "Object"

newClusterNodeType

newClusterNodeType: object

serializedName

serializedName: string = "typeProperties.newClusterNodeType"

type

type: object

name

name: "Object" = "Object"

newClusterNumOfWorker

newClusterNumOfWorker: object

serializedName

serializedName: string = "typeProperties.newClusterNumOfWorker"

type

type: object

name

name: "Object" = "Object"

newClusterSparkConf

newClusterSparkConf: object

serializedName

serializedName: string = "typeProperties.newClusterSparkConf"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Object" = "Object"

newClusterSparkEnvVars

newClusterSparkEnvVars: object

serializedName

serializedName: string = "typeProperties.newClusterSparkEnvVars"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Object" = "Object"

newClusterVersion

newClusterVersion: object

serializedName

serializedName: string = "typeProperties.newClusterVersion"

type

type: object

name

name: "Object" = "Object"

Const AzureKeyVaultLinkedService

AzureKeyVaultLinkedService: object
interface

An interface representing AzureKeyVaultLinkedService. Azure Key Vault linked service.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

baseUrl

baseUrl: any
member

{any} baseUrl The base URL of the Azure Key Vault. e.g. https://myakv.vault.azure.net Type: string (or Expression with resultType string).

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

serializedName

serializedName: string = "AzureKeyVault"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "AzureKeyVaultLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

baseUrl

baseUrl: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.baseUrl"

type

type: object

name

name: "Object" = "Object"

Const AzureKeyVaultSecretReference

AzureKeyVaultSecretReference: object
interface

An interface representing AzureKeyVaultSecretReference. Azure Key Vault secret reference.

secretName

secretName: any
member

{any} secretName The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string).

Optional secretVersion

secretVersion: any
member

{any} [secretVersion] The version of the secret in Azure Key Vault. The default value is the latest version of the secret. Type: string (or Expression with resultType string).

store

member

{LinkedServiceReference} store The Azure Key Vault linked service reference.

serializedName

serializedName: string = "AzureKeyVaultSecret"

type

type: object
member

{string} type Polymorphic Discriminator

className

className: string = "AzureKeyVaultSecretReference"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = SecretBase.type.polymorphicDiscriminator

uberParent

uberParent: string = "SecretBase"

modelProperties

modelProperties: object

secretName

secretName: object

required

required: true = true

serializedName

serializedName: string = "secretName"

type

type: object

name

name: "Object" = "Object"

secretVersion

secretVersion: object

serializedName

serializedName: string = "secretVersion"

type

type: object

name

name: "Object" = "Object"

store

store: object

defaultValue

defaultValue: object

Type declaration

required

required: true = true

serializedName

serializedName: string = "store"

type

type: object

className

className: string = "LinkedServiceReference"

name

name: "Composite" = "Composite"

Const AzureMLBatchExecutionActivity

AzureMLBatchExecutionActivity: object
interface

An interface representing AzureMLBatchExecutionActivity. Azure ML Batch Execution activity.

Optional dependsOn

dependsOn: ActivityDependency[]
member

{ActivityDependency[]} [dependsOn] Activity depends on condition.

Optional description

description: undefined | string
member

{string} [description] Activity description.

Optional globalParameters

globalParameters: undefined | object
member

{{ [propertyName: string]: any }} [globalParameters] Key,Value pairs to be passed to the Azure ML Batch Execution Service endpoint. Keys must match the names of web service parameters defined in the published Azure ML web service. Values will be passed in the GlobalParameters property of the Azure ML batch execution request.

Optional linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} [linkedServiceName] Linked service reference.

name

name: string
member

{string} name Activity name.

Optional policy

member

{ActivityPolicy} [policy] Activity policy.

Optional userProperties

userProperties: UserProperty[]
member

{UserProperty[]} [userProperties] Activity user properties.

Optional webServiceInputs

webServiceInputs: undefined | object
member

{{ [propertyName: string]: AzureMLWebServiceFile }} [webServiceInputs] Key,Value pairs, mapping the names of Azure ML endpoint's Web Service Inputs to AzureMLWebServiceFile objects specifying the input Blob locations.. This information will be passed in the WebServiceInputs property of the Azure ML batch execution request.

Optional webServiceOutputs

webServiceOutputs: undefined | object
member

{{ [propertyName: string]: AzureMLWebServiceFile }} [webServiceOutputs] Key,Value pairs, mapping the names of Azure ML endpoint's Web Service Outputs to AzureMLWebServiceFile objects specifying the output Blob locations. This information will be passed in the WebServiceOutputs property of the Azure ML batch execution request.

serializedName

serializedName: string = "AzureMLBatchExecution"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Activity.type.additionalProperties

className

className: string = "AzureMLBatchExecutionActivity"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Activity.type.polymorphicDiscriminator

uberParent

uberParent: string = "Activity"

modelProperties

modelProperties: object

globalParameters

globalParameters: object

serializedName

serializedName: string = "typeProperties.globalParameters"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Object" = "Object"

webServiceInputs

webServiceInputs: object

serializedName

serializedName: string = "typeProperties.webServiceInputs"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

className

className: string = "AzureMLWebServiceFile"

name

name: "Composite" = "Composite"

webServiceOutputs

webServiceOutputs: object

serializedName

serializedName: string = "typeProperties.webServiceOutputs"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

className

className: string = "AzureMLWebServiceFile"

name

name: "Composite" = "Composite"

Const AzureMLLinkedService

AzureMLLinkedService: object
interface

An interface representing AzureMLLinkedService. Azure ML Web Service linked service.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

apiKey

member

{SecretBaseUnion} apiKey The API key for accessing the Azure ML model endpoint.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

mlEndpoint

mlEndpoint: any
member

{any} mlEndpoint The Batch Execution REST URL for an Azure ML Web Service endpoint. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional servicePrincipalId

servicePrincipalId: any
member

{any} [servicePrincipalId] The ID of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML web service. Type: string (or Expression with resultType string).

Optional servicePrincipalKey

servicePrincipalKey: SecretBaseUnion
member

{SecretBaseUnion} [servicePrincipalKey] The key of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML web service.

Optional tenant

tenant: any
member

{any} [tenant] The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

Optional updateResourceEndpoint

updateResourceEndpoint: any
member

{any} [updateResourceEndpoint] The Update Resource REST URL for an Azure ML Web Service endpoint. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "AzureML"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "AzureMLLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

apiKey

apiKey: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.apiKey"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

mlEndpoint

mlEndpoint: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.mlEndpoint"

type

type: object

name

name: "Object" = "Object"

servicePrincipalId

servicePrincipalId: object

serializedName

serializedName: string = "typeProperties.servicePrincipalId"

type

type: object

name

name: "Object" = "Object"

servicePrincipalKey

servicePrincipalKey: object

serializedName

serializedName: string = "typeProperties.servicePrincipalKey"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

tenant

tenant: object

serializedName

serializedName: string = "typeProperties.tenant"

type

type: object

name

name: "Object" = "Object"

updateResourceEndpoint

updateResourceEndpoint: object

serializedName

serializedName: string = "typeProperties.updateResourceEndpoint"

type

type: object

name

name: "Object" = "Object"

Const AzureMLUpdateResourceActivity

AzureMLUpdateResourceActivity: object
interface

An interface representing AzureMLUpdateResourceActivity. Azure ML Update Resource management activity.

Optional dependsOn

dependsOn: ActivityDependency[]
member

{ActivityDependency[]} [dependsOn] Activity depends on condition.

Optional description

description: undefined | string
member

{string} [description] Activity description.

Optional linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} [linkedServiceName] Linked service reference.

name

name: string
member

{string} name Activity name.

Optional policy

member

{ActivityPolicy} [policy] Activity policy.

trainedModelFilePath

trainedModelFilePath: any
member

{any} trainedModelFilePath The relative file path in trainedModelLinkedService to represent the .ilearner file that will be uploaded by the update operation. Type: string (or Expression with resultType string).

trainedModelLinkedServiceName

trainedModelLinkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} trainedModelLinkedServiceName Name of Azure Storage linked service holding the .ilearner file that will be uploaded by the update operation.

trainedModelName

trainedModelName: any
member

{any} trainedModelName Name of the Trained Model module in the Web Service experiment to be updated. Type: string (or Expression with resultType string).

Optional userProperties

userProperties: UserProperty[]
member

{UserProperty[]} [userProperties] Activity user properties.

serializedName

serializedName: string = "AzureMLUpdateResource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Activity.type.additionalProperties

className

className: string = "AzureMLUpdateResourceActivity"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Activity.type.polymorphicDiscriminator

uberParent

uberParent: string = "Activity"

modelProperties

modelProperties: object

trainedModelFilePath

trainedModelFilePath: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.trainedModelFilePath"

type

type: object

name

name: "Object" = "Object"

trainedModelLinkedServiceName

trainedModelLinkedServiceName: object

defaultValue

defaultValue: object

Type declaration

required

required: true = true

serializedName

serializedName: string = "typeProperties.trainedModelLinkedServiceName"

type

type: object

className

className: string = "LinkedServiceReference"

name

name: "Composite" = "Composite"

trainedModelName

trainedModelName: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.trainedModelName"

type

type: object

name

name: "Object" = "Object"

Const AzureMLWebServiceFile

AzureMLWebServiceFile: object
interface

An interface representing AzureMLWebServiceFile. Azure ML WebService Input/Output file

filePath

filePath: any
member

{any} filePath The relative file path, including container name, in the Azure Blob Storage specified by the LinkedService. Type: string (or Expression with resultType string).

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Reference to an Azure Storage LinkedService, where Azure ML WebService Input/Output file located.

serializedName

serializedName: string = "AzureMLWebServiceFile"

type

type: object

className

className: string = "AzureMLWebServiceFile"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

filePath

filePath: object

required

required: true = true

serializedName

serializedName: string = "filePath"

type

type: object

name

name: "Object" = "Object"

linkedServiceName

linkedServiceName: object

defaultValue

defaultValue: object

Type declaration

required

required: true = true

serializedName

serializedName: string = "linkedServiceName"

type

type: object

className

className: string = "LinkedServiceReference"

name

name: "Composite" = "Composite"

Const AzureMySqlLinkedService

AzureMySqlLinkedService: object
interface

An interface representing AzureMySqlLinkedService. Azure MySQL database linked service.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

connectionString

connectionString: any
member

{any} connectionString The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional password

member

{AzureKeyVaultSecretReference} [password] The Azure key vault secret reference of password in connection string.

serializedName

serializedName: string = "AzureMySql"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "AzureMySqlLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

connectionString

connectionString: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.connectionString"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

password

password: object

serializedName

serializedName: string = "typeProperties.password"

type

type: object

className

className: string = "AzureKeyVaultSecretReference"

name

name: "Composite" = "Composite"

Const AzureMySqlSource

AzureMySqlSource: object
interface

An interface representing AzureMySqlSource. A copy activity Azure MySQL source.

Optional query

query: any
member

{any} [query] Database query. Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "AzureMySqlSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "AzureMySqlSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

Const AzureMySqlTableDataset

AzureMySqlTableDataset: object
interface

An interface representing AzureMySqlTableDataset. The Azure MySQL database dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Optional tableName

tableName: any
member

{any} [tableName] The Azure MySQL database table name. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "AzureMySqlTable"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "AzureMySqlTableDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

tableName

tableName: object

serializedName

serializedName: string = "typeProperties.tableName"

type

type: object

name

name: "Object" = "Object"

Const AzurePostgreSqlLinkedService

AzurePostgreSqlLinkedService: object
interface

An interface representing AzurePostgreSqlLinkedService. Azure PostgreSQL linked service.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional connectionString

connectionString: any
member

{any} [connectionString] An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional password

member

{AzureKeyVaultSecretReference} [password] The Azure key vault secret reference of password in connection string.

serializedName

serializedName: string = "AzurePostgreSql"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "AzurePostgreSqlLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

connectionString

connectionString: object

serializedName

serializedName: string = "typeProperties.connectionString"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

password

password: object

serializedName

serializedName: string = "typeProperties.password"

type

type: object

className

className: string = "AzureKeyVaultSecretReference"

name

name: "Composite" = "Composite"

Const AzurePostgreSqlSource

AzurePostgreSqlSource: object
interface

An interface representing AzurePostgreSqlSource. A copy activity Azure PostgreSQL source.

Optional query

query: any
member

{any} [query] A query to retrieve data from source. Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "AzurePostgreSqlSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "AzurePostgreSqlSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

Const AzurePostgreSqlTableDataset

AzurePostgreSqlTableDataset: object
interface

An interface representing AzurePostgreSqlTableDataset. Azure PostgreSQL dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Optional tableName

tableName: any
member

{any} [tableName] The table name. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "AzurePostgreSqlTable"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "AzurePostgreSqlTableDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

tableName

tableName: object

serializedName

serializedName: string = "typeProperties.tableName"

type

type: object

name

name: "Object" = "Object"

Const AzureQueueSink

AzureQueueSink: object
interface

An interface representing AzureQueueSink. A copy activity Azure Queue sink.

Optional sinkRetryCount

sinkRetryCount: any
member

{any} [sinkRetryCount] Sink retry count. Type: integer (or Expression with resultType integer).

Optional sinkRetryWait

sinkRetryWait: any
member

{any} [sinkRetryWait] Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Optional writeBatchSize

writeBatchSize: any
member

{any} [writeBatchSize] Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

Optional writeBatchTimeout

writeBatchTimeout: any
member

{any} [writeBatchTimeout] Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "AzureQueueSink"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySink.type.additionalProperties

className

className: string = "AzureQueueSink"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySink.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySink"

modelProperties

modelProperties: object

Const AzureSearchIndexDataset

AzureSearchIndexDataset: object
interface

An interface representing AzureSearchIndexDataset. The Azure Search Index.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

indexName

indexName: any
member

{any} indexName The name of the Azure Search Index. Type: string (or Expression with resultType string).

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

serializedName

serializedName: string = "AzureSearchIndex"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "AzureSearchIndexDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

indexName

indexName: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.indexName"

type

type: object

name

name: "Object" = "Object"

Const AzureSearchIndexSink

AzureSearchIndexSink: object
interface

An interface representing AzureSearchIndexSink. A copy activity Azure Search Index sink.

Optional sinkRetryCount

sinkRetryCount: any
member

{any} [sinkRetryCount] Sink retry count. Type: integer (or Expression with resultType integer).

Optional sinkRetryWait

sinkRetryWait: any
member

{any} [sinkRetryWait] Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Optional writeBatchSize

writeBatchSize: any
member

{any} [writeBatchSize] Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

Optional writeBatchTimeout

writeBatchTimeout: any
member

{any} [writeBatchTimeout] Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Optional writeBehavior

member

{AzureSearchIndexWriteBehaviorType} [writeBehavior] Specify the write behavior when upserting documents into Azure Search Index. Possible values include: 'Merge', 'Upload'

serializedName

serializedName: string = "AzureSearchIndexSink"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySink.type.additionalProperties

className

className: string = "AzureSearchIndexSink"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySink.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySink"

modelProperties

modelProperties: object

writeBehavior

writeBehavior: object

serializedName

serializedName: string = "writeBehavior"

type

type: object

name

name: "String" = "String"

Const AzureSearchLinkedService

AzureSearchLinkedService: object
interface

An interface representing AzureSearchLinkedService. Linked service for Windows Azure Search Service.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional key

member

{SecretBaseUnion} [key] Admin Key for Azure Search service

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

url

url: any
member

{any} url URL for Azure Search service. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "AzureSearch"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "AzureSearchLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

key

key: object

serializedName

serializedName: string = "typeProperties.key"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

url

url: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.url"

type

type: object

name

name: "Object" = "Object"

Const AzureSqlDWLinkedService

AzureSqlDWLinkedService: object
interface

An interface representing AzureSqlDWLinkedService. Azure SQL Data Warehouse linked service.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

connectionString

connectionString: any
member

{any} connectionString The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional password

member

{AzureKeyVaultSecretReference} [password] The Azure key vault secret reference of password in connection string.

Optional servicePrincipalId

servicePrincipalId: any
member

{any} [servicePrincipalId] The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string).

Optional servicePrincipalKey

servicePrincipalKey: SecretBaseUnion
member

{SecretBaseUnion} [servicePrincipalKey] The key of the service principal used to authenticate against Azure SQL Data Warehouse.

Optional tenant

tenant: any
member

{any} [tenant] The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "AzureSqlDW"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "AzureSqlDWLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

connectionString

connectionString: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.connectionString"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

password

password: object

serializedName

serializedName: string = "typeProperties.password"

type

type: object

className

className: string = "AzureKeyVaultSecretReference"

name

name: "Composite" = "Composite"

servicePrincipalId

servicePrincipalId: object

serializedName

serializedName: string = "typeProperties.servicePrincipalId"

type

type: object

name

name: "Object" = "Object"

servicePrincipalKey

servicePrincipalKey: object

serializedName

serializedName: string = "typeProperties.servicePrincipalKey"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

tenant

tenant: object

serializedName

serializedName: string = "typeProperties.tenant"

type

type: object

name

name: "Object" = "Object"

Const AzureSqlDWTableDataset

AzureSqlDWTableDataset: object
interface

An interface representing AzureSqlDWTableDataset. The Azure SQL Data Warehouse dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

tableName

tableName: any
member

{any} tableName The table name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "AzureSqlDWTable"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "AzureSqlDWTableDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

tableName

tableName: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.tableName"

type

type: object

name

name: "Object" = "Object"

Const AzureSqlDatabaseLinkedService

AzureSqlDatabaseLinkedService: object
interface

An interface representing AzureSqlDatabaseLinkedService. Microsoft Azure SQL Database linked service.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

connectionString

connectionString: any
member

{any} connectionString The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional password

member

{AzureKeyVaultSecretReference} [password] The Azure key vault secret reference of password in connection string.

Optional servicePrincipalId

servicePrincipalId: any
member

{any} [servicePrincipalId] The ID of the service principal used to authenticate against Azure SQL Database. Type: string (or Expression with resultType string).

Optional servicePrincipalKey

servicePrincipalKey: SecretBaseUnion
member

{SecretBaseUnion} [servicePrincipalKey] The key of the service principal used to authenticate against Azure SQL Database.

Optional tenant

tenant: any
member

{any} [tenant] The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "AzureSqlDatabase"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "AzureSqlDatabaseLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

connectionString

connectionString: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.connectionString"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

password

password: object

serializedName

serializedName: string = "typeProperties.password"

type

type: object

className

className: string = "AzureKeyVaultSecretReference"

name

name: "Composite" = "Composite"

servicePrincipalId

servicePrincipalId: object

serializedName

serializedName: string = "typeProperties.servicePrincipalId"

type

type: object

name

name: "Object" = "Object"

servicePrincipalKey

servicePrincipalKey: object

serializedName

serializedName: string = "typeProperties.servicePrincipalKey"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

tenant

tenant: object

serializedName

serializedName: string = "typeProperties.tenant"

type

type: object

name

name: "Object" = "Object"

Const AzureSqlTableDataset

AzureSqlTableDataset: object
interface

An interface representing AzureSqlTableDataset. The Azure SQL Server database dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

tableName

tableName: any
member

{any} tableName The table name of the Azure SQL database. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "AzureSqlTable"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "AzureSqlTableDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

tableName

tableName: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.tableName"

type

type: object

name

name: "Object" = "Object"

Const AzureStorageLinkedService

AzureStorageLinkedService: object
interface

An interface representing AzureStorageLinkedService. The storage account linked service.

Optional accountKey

member

{AzureKeyVaultSecretReference} [accountKey] The Azure key vault secret reference of accountKey in connection string.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional connectionString

connectionString: any
member

{any} [connectionString] The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: undefined | string
member

{string} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional sasToken

member

{AzureKeyVaultSecretReference} [sasToken] The Azure key vault secret reference of sasToken in sas uri.

Optional sasUri

sasUri: any
member

{any} [sasUri] SAS URI of the Azure Storage resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference.

serializedName

serializedName: string = "AzureStorage"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "AzureStorageLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

accountKey

accountKey: object

serializedName

serializedName: string = "typeProperties.accountKey"

type

type: object

className

className: string = "AzureKeyVaultSecretReference"

name

name: "Composite" = "Composite"

connectionString

connectionString: object

serializedName

serializedName: string = "typeProperties.connectionString"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "String" = "String"

sasToken

sasToken: object

serializedName

serializedName: string = "typeProperties.sasToken"

type

type: object

className

className: string = "AzureKeyVaultSecretReference"

name

name: "Composite" = "Composite"

sasUri

sasUri: object

serializedName

serializedName: string = "typeProperties.sasUri"

type

type: object

name

name: "Object" = "Object"

Const AzureTableDataset

AzureTableDataset: object
interface

An interface representing AzureTableDataset. The Azure Table storage dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

tableName

tableName: any
member

{any} tableName The table name of the Azure Table storage. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "AzureTable"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "AzureTableDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

tableName

tableName: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.tableName"

type

type: object

name

name: "Object" = "Object"

Const AzureTableSink

AzureTableSink: object
interface

An interface representing AzureTableSink. A copy activity Azure Table sink.

Optional azureTableDefaultPartitionKeyValue

azureTableDefaultPartitionKeyValue: any
member

{any} [azureTableDefaultPartitionKeyValue] Azure Table default partition key value. Type: string (or Expression with resultType string).

Optional azureTableInsertType

azureTableInsertType: any
member

{any} [azureTableInsertType] Azure Table insert type. Type: string (or Expression with resultType string).

Optional azureTablePartitionKeyName

azureTablePartitionKeyName: any
member

{any} [azureTablePartitionKeyName] Azure Table partition key name. Type: string (or Expression with resultType string).

Optional azureTableRowKeyName

azureTableRowKeyName: any
member

{any} [azureTableRowKeyName] Azure Table row key name. Type: string (or Expression with resultType string).

Optional sinkRetryCount

sinkRetryCount: any
member

{any} [sinkRetryCount] Sink retry count. Type: integer (or Expression with resultType integer).

Optional sinkRetryWait

sinkRetryWait: any
member

{any} [sinkRetryWait] Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Optional writeBatchSize

writeBatchSize: any
member

{any} [writeBatchSize] Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

Optional writeBatchTimeout

writeBatchTimeout: any
member

{any} [writeBatchTimeout] Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "AzureTableSink"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySink.type.additionalProperties

className

className: string = "AzureTableSink"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySink.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySink"

modelProperties

modelProperties: object

azureTableDefaultPartitionKeyValue

azureTableDefaultPartitionKeyValue: object

serializedName

serializedName: string = "azureTableDefaultPartitionKeyValue"

type

type: object

name

name: "Object" = "Object"

azureTableInsertType

azureTableInsertType: object

serializedName

serializedName: string = "azureTableInsertType"

type

type: object

name

name: "Object" = "Object"

azureTablePartitionKeyName

azureTablePartitionKeyName: object

serializedName

serializedName: string = "azureTablePartitionKeyName"

type

type: object

name

name: "Object" = "Object"

azureTableRowKeyName

azureTableRowKeyName: object

serializedName

serializedName: string = "azureTableRowKeyName"

type

type: object

name

name: "Object" = "Object"

Const AzureTableSource

AzureTableSource: object
interface

An interface representing AzureTableSource. A copy activity Azure Table source.

Optional azureTableSourceIgnoreTableNotFound

azureTableSourceIgnoreTableNotFound: any
member

{any} [azureTableSourceIgnoreTableNotFound] Azure Table source ignore table not found. Type: boolean (or Expression with resultType boolean).

Optional azureTableSourceQuery

azureTableSourceQuery: any
member

{any} [azureTableSourceQuery] Azure Table source query. Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "AzureTableSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "AzureTableSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

azureTableSourceIgnoreTableNotFound

azureTableSourceIgnoreTableNotFound: object

serializedName

serializedName: string = "azureTableSourceIgnoreTableNotFound"

type

type: object

name

name: "Object" = "Object"

azureTableSourceQuery

azureTableSourceQuery: object

serializedName

serializedName: string = "azureTableSourceQuery"

type

type: object

name

name: "Object" = "Object"

Const AzureTableStorageLinkedService

AzureTableStorageLinkedService: object
interface

An interface representing AzureTableStorageLinkedService. The azure table storage linked service.

Optional accountKey

member

{AzureKeyVaultSecretReference} [accountKey] The Azure key vault secret reference of accountKey in connection string.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional connectionString

connectionString: any
member

{any} [connectionString] The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: undefined | string
member

{string} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional sasToken

member

{AzureKeyVaultSecretReference} [sasToken] The Azure key vault secret reference of sasToken in sas uri.

Optional sasUri

sasUri: any
member

{any} [sasUri] SAS URI of the Azure Storage resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference.

serializedName

serializedName: string = "AzureTableStorage"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "AzureTableStorageLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

accountKey

accountKey: object

serializedName

serializedName: string = "typeProperties.accountKey"

type

type: object

className

className: string = "AzureKeyVaultSecretReference"

name

name: "Composite" = "Composite"

connectionString

connectionString: object

serializedName

serializedName: string = "typeProperties.connectionString"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "String" = "String"

sasToken

sasToken: object

serializedName

serializedName: string = "typeProperties.sasToken"

type

type: object

className

className: string = "AzureKeyVaultSecretReference"

name

name: "Composite" = "Composite"

sasUri

sasUri: object

serializedName

serializedName: string = "typeProperties.sasUri"

type

type: object

name

name: "Object" = "Object"

Const BlobEventsTrigger

BlobEventsTrigger: object
interface

An interface representing BlobEventsTrigger. Trigger that runs everytime a Blob event occurs.

Optional blobPathBeginsWith

blobPathBeginsWith: undefined | string
member

{string} [blobPathBeginsWith] The blob path must begin with the pattern provided for trigger to fire. For example, '/records/blobs/december/' will only fire the trigger for blobs in the december folder under the records container. At least one of these must be provided: blobPathBeginsWith, blobPathEndsWith.

Optional blobPathEndsWith

blobPathEndsWith: undefined | string
member

{string} [blobPathEndsWith] The blob path must end with the pattern provided for trigger to fire. For example, 'december/boxes.csv' will only fire the trigger for blobs named boxes in a december folder. At least one of these must be provided: blobPathBeginsWith, blobPathEndsWith.

Optional description

description: undefined | string
member

{string} [description] Trigger description.

events

events: BlobEventTypes[]
member

{BlobEventTypes[]} events The type of events that cause this trigger to fire.

Optional pipelines

member

{TriggerPipelineReference[]} [pipelines] Pipelines that need to be started.

Optional runtimeState

runtimeState: TriggerRuntimeState
member

{TriggerRuntimeState} [runtimeState] Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. Possible values include: 'Started', 'Stopped', 'Disabled' NOTE: This property will not be serialized. It can only be populated by the server.

scope

scope: string
member

{string} scope The ARM resource ID of the Storage Account.

serializedName

serializedName: string = "BlobEventsTrigger"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Trigger.type.additionalProperties

className

className: string = "BlobEventsTrigger"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Trigger.type.polymorphicDiscriminator

uberParent

uberParent: string = "Trigger"

modelProperties

modelProperties: object

blobPathBeginsWith

blobPathBeginsWith: object

serializedName

serializedName: string = "typeProperties.blobPathBeginsWith"

type

type: object

name

name: "String" = "String"

blobPathEndsWith

blobPathEndsWith: object

serializedName

serializedName: string = "typeProperties.blobPathEndsWith"

type

type: object

name

name: "String" = "String"

events

events: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.events"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

scope

scope: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.scope"

type

type: object

name

name: "String" = "String"

Const BlobSink

BlobSink: object
interface

An interface representing BlobSink. A copy activity Azure Blob sink.

Optional blobWriterAddHeader

blobWriterAddHeader: any
member

{any} [blobWriterAddHeader] Blob writer add header. Type: boolean (or Expression with resultType boolean).

Optional blobWriterDateTimeFormat

blobWriterDateTimeFormat: any
member

{any} [blobWriterDateTimeFormat] Blob writer date time format. Type: string (or Expression with resultType string).

Optional blobWriterOverwriteFiles

blobWriterOverwriteFiles: any
member

{any} [blobWriterOverwriteFiles] Blob writer overwrite files. Type: boolean (or Expression with resultType boolean).

Optional copyBehavior

copyBehavior: CopyBehaviorType
member

{CopyBehaviorType} [copyBehavior] The type of copy behavior for copy sink. Possible values include: 'PreserveHierarchy', 'FlattenHierarchy', 'MergeFiles'

Optional sinkRetryCount

sinkRetryCount: any
member

{any} [sinkRetryCount] Sink retry count. Type: integer (or Expression with resultType integer).

Optional sinkRetryWait

sinkRetryWait: any
member

{any} [sinkRetryWait] Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Optional writeBatchSize

writeBatchSize: any
member

{any} [writeBatchSize] Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

Optional writeBatchTimeout

writeBatchTimeout: any
member

{any} [writeBatchTimeout] Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "BlobSink"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySink.type.additionalProperties

className

className: string = "BlobSink"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySink.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySink"

modelProperties

modelProperties: object

blobWriterAddHeader

blobWriterAddHeader: object

serializedName

serializedName: string = "blobWriterAddHeader"

type

type: object

name

name: "Object" = "Object"

blobWriterDateTimeFormat

blobWriterDateTimeFormat: object

serializedName

serializedName: string = "blobWriterDateTimeFormat"

type

type: object

name

name: "Object" = "Object"

blobWriterOverwriteFiles

blobWriterOverwriteFiles: object

serializedName

serializedName: string = "blobWriterOverwriteFiles"

type

type: object

name

name: "Object" = "Object"

copyBehavior

copyBehavior: object

serializedName

serializedName: string = "copyBehavior"

type

type: object

name

name: "String" = "String"

Const BlobSource

BlobSource: object
interface

An interface representing BlobSource. A copy activity Azure Blob source.

Optional recursive

recursive: any
member

{any} [recursive] If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

Optional skipHeaderLineCount

skipHeaderLineCount: any
member

{any} [skipHeaderLineCount] Number of header lines to skip from each blob. Type: integer (or Expression with resultType integer).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Optional treatEmptyAsNull

treatEmptyAsNull: any
member

{any} [treatEmptyAsNull] Treat empty as null. Type: boolean (or Expression with resultType boolean).

serializedName

serializedName: string = "BlobSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "BlobSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

recursive

recursive: object

serializedName

serializedName: string = "recursive"

type

type: object

name

name: "Object" = "Object"

skipHeaderLineCount

skipHeaderLineCount: object

serializedName

serializedName: string = "skipHeaderLineCount"

type

type: object

name

name: "Object" = "Object"

treatEmptyAsNull

treatEmptyAsNull: object

serializedName

serializedName: string = "treatEmptyAsNull"

type

type: object

name

name: "Object" = "Object"

Const BlobTrigger

BlobTrigger: object
interface

An interface representing BlobTrigger. Trigger that runs everytime the selected Blob container changes.

Optional description

description: undefined | string
member

{string} [description] Trigger description.

folderPath

folderPath: string
member

{string} folderPath The path of the container/folder that will trigger the pipeline.

linkedService

linkedService: LinkedServiceReference
member

{LinkedServiceReference} linkedService The Azure Storage linked service reference.

maxConcurrency

maxConcurrency: number
member

{number} maxConcurrency The max number of parallel files to handle when it is triggered.

Optional pipelines

member

{TriggerPipelineReference[]} [pipelines] Pipelines that need to be started.

Optional runtimeState

runtimeState: TriggerRuntimeState
member

{TriggerRuntimeState} [runtimeState] Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. Possible values include: 'Started', 'Stopped', 'Disabled' NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "BlobTrigger"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Trigger.type.additionalProperties

className

className: string = "BlobTrigger"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Trigger.type.polymorphicDiscriminator

uberParent

uberParent: string = "Trigger"

modelProperties

modelProperties: object

folderPath

folderPath: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.folderPath"

type

type: object

name

name: "String" = "String"

linkedService

linkedService: object

defaultValue

defaultValue: object

Type declaration

required

required: true = true

serializedName

serializedName: string = "typeProperties.linkedService"

type

type: object

className

className: string = "LinkedServiceReference"

name

name: "Composite" = "Composite"

maxConcurrency

maxConcurrency: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.maxConcurrency"

type

type: object

name

name: "Number" = "Number"

Const CassandraLinkedService

CassandraLinkedService: object
interface

An interface representing CassandraLinkedService. Linked service for Cassandra data source.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional authenticationType

authenticationType: any
member

{any} [authenticationType] AuthenticationType to be used for connection. Type: string (or Expression with resultType string).

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

host

host: any
member

{any} host Host name for connection. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional password

password: SecretBaseUnion
member

{SecretBaseUnion} [password] Password for authentication.

Optional port

port: any
member

{any} [port] The port for the connection. Type: integer (or Expression with resultType integer).

Optional username

username: any
member

{any} [username] Username for authentication. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "Cassandra"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "CassandraLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

authenticationType

authenticationType: object

serializedName

serializedName: string = "typeProperties.authenticationType"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

host

host: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.host"

type

type: object

name

name: "Object" = "Object"

password

password: object

serializedName

serializedName: string = "typeProperties.password"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

port

port: object

serializedName

serializedName: string = "typeProperties.port"

type

type: object

name

name: "Object" = "Object"

username

username: object

serializedName

serializedName: string = "typeProperties.username"

type

type: object

name

name: "Object" = "Object"

Const CassandraSource

CassandraSource: object
interface

An interface representing CassandraSource. A copy activity source for a Cassandra database.

Optional consistencyLevel

member

{CassandraSourceReadConsistencyLevels} [consistencyLevel] The consistency level specifies how many Cassandra servers must respond to a read request before returning data to the client application. Cassandra checks the specified number of Cassandra servers for data to satisfy the read request. Must be one of cassandraSourceReadConsistencyLevels. The default value is 'ONE'. It is case-insensitive. Possible values include: 'ALL', 'EACH_QUORUM', 'QUORUM', 'LOCAL_QUORUM', 'ONE', 'TWO', 'THREE', 'LOCAL_ONE', 'SERIAL', 'LOCAL_SERIAL'

Optional query

query: any
member

{any} [query] Database query. Should be a SQL-92 query expression or Cassandra Query Language (CQL) command. Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "CassandraSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "CassandraSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

consistencyLevel

consistencyLevel: object

serializedName

serializedName: string = "consistencyLevel"

type

type: object

name

name: "String" = "String"

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

Const CassandraTableDataset

CassandraTableDataset: object
interface

An interface representing CassandraTableDataset. The Cassandra database dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

Optional keyspace

keyspace: any
member

{any} [keyspace] The keyspace of the Cassandra database. Type: string (or Expression with resultType string).

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Optional tableName

tableName: any
member

{any} [tableName] The table name of the Cassandra database. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "CassandraTable"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "CassandraTableDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

keyspace

keyspace: object

serializedName

serializedName: string = "typeProperties.keyspace"

type

type: object

name

name: "Object" = "Object"

tableName

tableName: object

serializedName

serializedName: string = "typeProperties.tableName"

type

type: object

name

name: "Object" = "Object"

Const ConcurLinkedService

ConcurLinkedService: object
interface

An interface representing ConcurLinkedService. Concur Serivce linked service.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

clientId

clientId: any
member

{any} clientId Application client_id supplied by Concur App Management.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional password

password: SecretBaseUnion
member

{SecretBaseUnion} [password] The password corresponding to the user name that you provided in the username field.

Optional useEncryptedEndpoints

useEncryptedEndpoints: any
member

{any} [useEncryptedEndpoints] Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

Optional useHostVerification

useHostVerification: any
member

{any} [useHostVerification] Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.

Optional usePeerVerification

usePeerVerification: any
member

{any} [usePeerVerification] Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

username

username: any
member

{any} username The user name that you use to access Concur Service.

serializedName

serializedName: string = "Concur"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "ConcurLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

clientId

clientId: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.clientId"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

password

password: object

serializedName

serializedName: string = "typeProperties.password"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

useEncryptedEndpoints

useEncryptedEndpoints: object

serializedName

serializedName: string = "typeProperties.useEncryptedEndpoints"

type

type: object

name

name: "Object" = "Object"

useHostVerification

useHostVerification: object

serializedName

serializedName: string = "typeProperties.useHostVerification"

type

type: object

name

name: "Object" = "Object"

usePeerVerification

usePeerVerification: object

serializedName

serializedName: string = "typeProperties.usePeerVerification"

type

type: object

name

name: "Object" = "Object"

username

username: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.username"

type

type: object

name

name: "Object" = "Object"

Const ConcurObjectDataset

ConcurObjectDataset: object
interface

An interface representing ConcurObjectDataset. Concur Serivce dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Optional tableName

tableName: any
member

{any} [tableName] The table name. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "ConcurObject"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "ConcurObjectDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

tableName

tableName: object

serializedName

serializedName: string = "typeProperties.tableName"

type

type: object

name

name: "Object" = "Object"

Const ConcurSource

ConcurSource: object
interface

An interface representing ConcurSource. A copy activity Concur Serivce source.

Optional query

query: any
member

{any} [query] A query to retrieve data from source. Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "ConcurSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "ConcurSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

Const ControlActivity

ControlActivity: object
interface

An interface representing ControlActivity. Base class for all control activities like IfCondition, ForEach , Until.

Optional dependsOn

dependsOn: ActivityDependency[]
member

{ActivityDependency[]} [dependsOn] Activity depends on condition.

Optional description

description: undefined | string
member

{string} [description] Activity description.

name

name: string
member

{string} name Activity name.

Optional userProperties

userProperties: UserProperty[]
member

{UserProperty[]} [userProperties] Activity user properties.

serializedName

serializedName: string = "Container"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Activity.type.additionalProperties

className

className: string = "ControlActivity"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Activity.type.polymorphicDiscriminator

uberParent

uberParent: string = "Activity"

modelProperties

modelProperties: object

Const CopyActivity

CopyActivity: object
interface

An interface representing CopyActivity. Copy activity.

Optional dataIntegrationUnits

dataIntegrationUnits: any
member

{any} [dataIntegrationUnits] Maximum number of data integration units that can be used to perform this data movement. Type: integer (or Expression with resultType integer), minimum: 0.

Optional dependsOn

dependsOn: ActivityDependency[]
member

{ActivityDependency[]} [dependsOn] Activity depends on condition.

Optional description

description: undefined | string
member

{string} [description] Activity description.

Optional enableSkipIncompatibleRow

enableSkipIncompatibleRow: any
member

{any} [enableSkipIncompatibleRow] Whether to skip incompatible row. Default value is false. Type: boolean (or Expression with resultType boolean).

Optional enableStaging

enableStaging: any
member

{any} [enableStaging] Specifies whether to copy data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean).

Optional inputs

member

{DatasetReference[]} [inputs] List of inputs for the activity.

Optional linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} [linkedServiceName] Linked service reference.

name

name: string
member

{string} name Activity name.

Optional outputs

outputs: DatasetReference[]
member

{DatasetReference[]} [outputs] List of outputs for the activity.

Optional parallelCopies

parallelCopies: any
member

{any} [parallelCopies] Maximum number of concurrent sessions opened on the source or sink to avoid overloading the data store. Type: integer (or Expression with resultType integer), minimum: 0.

Optional policy

member

{ActivityPolicy} [policy] Activity policy.

Optional redirectIncompatibleRowSettings

redirectIncompatibleRowSettings: RedirectIncompatibleRowSettings
member

{RedirectIncompatibleRowSettings} [redirectIncompatibleRowSettings] Redirect incompatible row settings when EnableSkipIncompatibleRow is true.

sink

member

{CopySinkUnion} sink Copy activity sink.

source

member

{CopySourceUnion} source Copy activity source.

Optional stagingSettings

stagingSettings: StagingSettings
member

{StagingSettings} [stagingSettings] Specifies interim staging settings when EnableStaging is true.

Optional translator

member

{CopyTranslatorUnion} [translator] Copy activity translator. If not specificed, tabular translator is used.

Optional userProperties

userProperties: UserProperty[]
member

{UserProperty[]} [userProperties] Activity user properties.

serializedName

serializedName: string = "Copy"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Activity.type.additionalProperties

className

className: string = "CopyActivity"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Activity.type.polymorphicDiscriminator

uberParent

uberParent: string = "Activity"

modelProperties

modelProperties: object

dataIntegrationUnits

dataIntegrationUnits: object

serializedName

serializedName: string = "typeProperties.dataIntegrationUnits"

type

type: object

name

name: "Object" = "Object"

enableSkipIncompatibleRow

enableSkipIncompatibleRow: object

serializedName

serializedName: string = "typeProperties.enableSkipIncompatibleRow"

type

type: object

name

name: "Object" = "Object"

enableStaging

enableStaging: object

serializedName

serializedName: string = "typeProperties.enableStaging"

type

type: object

name

name: "Object" = "Object"

inputs

inputs: object

serializedName

serializedName: string = "inputs"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DatasetReference"

name

name: "Composite" = "Composite"

outputs

outputs: object

serializedName

serializedName: string = "outputs"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DatasetReference"

name

name: "Composite" = "Composite"

parallelCopies

parallelCopies: object

serializedName

serializedName: string = "typeProperties.parallelCopies"

type

type: object

name

name: "Object" = "Object"

redirectIncompatibleRowSettings

redirectIncompatibleRowSettings: object

serializedName

serializedName: string = "typeProperties.redirectIncompatibleRowSettings"

type

type: object

className

className: string = "RedirectIncompatibleRowSettings"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

sink

sink: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.sink"

type

type: object

className

className: string = "CopySink"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

source

source: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.source"

type

type: object

className

className: string = "CopySource"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

stagingSettings

stagingSettings: object

serializedName

serializedName: string = "typeProperties.stagingSettings"

type

type: object

className

className: string = "StagingSettings"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

translator

translator: object

serializedName

serializedName: string = "typeProperties.translator"

type

type: object

className

className: string = "CopyTranslator"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

Const CopySink

CopySink: object
interface

An interface representing CopySink. A copy activity sink.

Optional sinkRetryCount

sinkRetryCount: any
member

{any} [sinkRetryCount] Sink retry count. Type: integer (or Expression with resultType integer).

Optional sinkRetryWait

sinkRetryWait: any
member

{any} [sinkRetryWait] Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Optional writeBatchSize

writeBatchSize: any
member

{any} [writeBatchSize] Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

Optional writeBatchTimeout

writeBatchTimeout: any
member

{any} [writeBatchTimeout] Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "CopySink"

type

type: object
member

{string} type Polymorphic Discriminator

className

className: string = "CopySink"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "CopySink"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

modelProperties

modelProperties: object

sinkRetryCount

sinkRetryCount: object

serializedName

serializedName: string = "sinkRetryCount"

type

type: object

name

name: "Object" = "Object"

sinkRetryWait

sinkRetryWait: object

serializedName

serializedName: string = "sinkRetryWait"

type

type: object

name

name: "Object" = "Object"

type

type: object

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

writeBatchSize

writeBatchSize: object

serializedName

serializedName: string = "writeBatchSize"

type

type: object

name

name: "Object" = "Object"

writeBatchTimeout

writeBatchTimeout: object

serializedName

serializedName: string = "writeBatchTimeout"

type

type: object

name

name: "Object" = "Object"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "type"

serializedName

serializedName: string = "type"

Const CopySource

CopySource: object
interface

An interface representing CopySource. A copy activity source.

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "CopySource"

type

type: object
member

{string} type Polymorphic Discriminator

className

className: string = "CopySource"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "CopySource"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

modelProperties

modelProperties: object

sourceRetryCount

sourceRetryCount: object

serializedName

serializedName: string = "sourceRetryCount"

type

type: object

name

name: "Object" = "Object"

sourceRetryWait

sourceRetryWait: object

serializedName

serializedName: string = "sourceRetryWait"

type

type: object

name

name: "Object" = "Object"

type

type: object

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "type"

serializedName

serializedName: string = "type"

Const CopyTranslator

CopyTranslator: object
interface

An interface representing CopyTranslator. A copy activity translator.

serializedName

serializedName: string = "CopyTranslator"

type

type: object
member

{string} type Polymorphic Discriminator

className

className: string = "CopyTranslator"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "CopyTranslator"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

modelProperties

modelProperties: object

type

type: object

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "type"

serializedName

serializedName: string = "type"

Const CosmosDbLinkedService

CosmosDbLinkedService: object
interface

An interface representing CosmosDbLinkedService. Microsoft Azure Cosmos Database (CosmosDB) linked service.

Optional accountKey

member

{AzureKeyVaultSecretReference} [accountKey] The Azure key vault secret reference of accountKey in connection string.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

connectionString

connectionString: any
member

{any} connectionString The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

serializedName

serializedName: string = "CosmosDb"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "CosmosDbLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

accountKey

accountKey: object

serializedName

serializedName: string = "typeProperties.accountKey"

type

type: object

className

className: string = "AzureKeyVaultSecretReference"

name

name: "Composite" = "Composite"

connectionString

connectionString: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.connectionString"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

Const CouchbaseLinkedService

CouchbaseLinkedService: object
interface

An interface representing CouchbaseLinkedService. Couchbase server linked service.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional connectionString

connectionString: any
member

{any} [connectionString] An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

Optional credString

member

{AzureKeyVaultSecretReference} [credString] The Azure key vault secret reference of credString in connection string.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

serializedName

serializedName: string = "Couchbase"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "CouchbaseLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

connectionString

connectionString: object

serializedName

serializedName: string = "typeProperties.connectionString"

type

type: object

name

name: "Object" = "Object"

credString

credString: object

serializedName

serializedName: string = "typeProperties.credString"

type

type: object

className

className: string = "AzureKeyVaultSecretReference"

name

name: "Composite" = "Composite"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

Const CouchbaseSource

CouchbaseSource: object
interface

An interface representing CouchbaseSource. A copy activity Couchbase server source.

Optional query

query: any
member

{any} [query] A query to retrieve data from source. Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "CouchbaseSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "CouchbaseSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

Const CouchbaseTableDataset

CouchbaseTableDataset: object
interface

An interface representing CouchbaseTableDataset. Couchbase server dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Optional tableName

tableName: any
member

{any} [tableName] The table name. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "CouchbaseTable"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "CouchbaseTableDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

tableName

tableName: object

serializedName

serializedName: string = "typeProperties.tableName"

type

type: object

name

name: "Object" = "Object"

Const CreateLinkedIntegrationRuntimeRequest

CreateLinkedIntegrationRuntimeRequest: object
interface

An interface representing CreateLinkedIntegrationRuntimeRequest. The linked integration runtime information.

Optional dataFactoryLocation

dataFactoryLocation: undefined | string
member

{string} [dataFactoryLocation] The location of the data factory that the linked integration runtime belongs to.

Optional dataFactoryName

dataFactoryName: undefined | string
member

{string} [dataFactoryName] The name of the data factory that the linked integration runtime belongs to.

Optional name

name: undefined | string
member

{string} [name] The name of the linked integration runtime.

Optional subscriptionId

subscriptionId: undefined | string
member

{string} [subscriptionId] The ID of the subscription that the linked integration runtime belongs to.

serializedName

serializedName: string = "CreateLinkedIntegrationRuntimeRequest"

type

type: object

className

className: string = "CreateLinkedIntegrationRuntimeRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dataFactoryLocation

dataFactoryLocation: object

serializedName

serializedName: string = "dataFactoryLocation"

type

type: object

name

name: "String" = "String"

dataFactoryName

dataFactoryName: object

serializedName

serializedName: string = "dataFactoryName"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

subscriptionId

subscriptionId: object

serializedName

serializedName: string = "subscriptionId"

type

type: object

name

name: "String" = "String"

Const CreateRunResponse

CreateRunResponse: object
interface

An interface representing CreateRunResponse. Response body with a run identifier.

runId

runId: string
member

{string} runId Identifier of a run.

serializedName

serializedName: string = "CreateRunResponse"

type

type: object

className

className: string = "CreateRunResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

runId

runId: object

required

required: true = true

serializedName

serializedName: string = "runId"

type

type: object

name

name: "String" = "String"

Const CustomActivity

CustomActivity: object
interface

An interface representing CustomActivity. Custom activity type.

command

command: any
member

{any} command Command for custom activity Type: string (or Expression with resultType string).

Optional dependsOn

dependsOn: ActivityDependency[]
member

{ActivityDependency[]} [dependsOn] Activity depends on condition.

Optional description

description: undefined | string
member

{string} [description] Activity description.

Optional extendedProperties

extendedProperties: undefined | object
member

{{ [propertyName: string]: any }} [extendedProperties] User defined property bag. There is no restriction on the keys or values that can be used. The user specified custom activity has the full responsibility to consume and interpret the content defined.

Optional folderPath

folderPath: any
member

{any} [folderPath] Folder path for resource files Type: string (or Expression with resultType string).

Optional linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} [linkedServiceName] Linked service reference.

name

name: string
member

{string} name Activity name.

Optional policy

member

{ActivityPolicy} [policy] Activity policy.

Optional referenceObjects

member

{CustomActivityReferenceObject} [referenceObjects] Reference objects

Optional resourceLinkedService

resourceLinkedService: LinkedServiceReference
member

{LinkedServiceReference} [resourceLinkedService] Resource linked service reference.

Optional userProperties

userProperties: UserProperty[]
member

{UserProperty[]} [userProperties] Activity user properties.

serializedName

serializedName: string = "Custom"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Activity.type.additionalProperties

className

className: string = "CustomActivity"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Activity.type.polymorphicDiscriminator

uberParent

uberParent: string = "Activity"

modelProperties

modelProperties: object

command

command: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.command"

type

type: object

name

name: "Object" = "Object"

extendedProperties

extendedProperties: object

serializedName

serializedName: string = "typeProperties.extendedProperties"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Object" = "Object"

folderPath

folderPath: object

serializedName

serializedName: string = "typeProperties.folderPath"

type

type: object

name

name: "Object" = "Object"

referenceObjects

referenceObjects: object

serializedName

serializedName: string = "typeProperties.referenceObjects"

type

type: object

className

className: string = "CustomActivityReferenceObject"

name

name: "Composite" = "Composite"

resourceLinkedService

resourceLinkedService: object

serializedName

serializedName: string = "typeProperties.resourceLinkedService"

type

type: object

className

className: string = "LinkedServiceReference"

name

name: "Composite" = "Composite"

Const CustomActivityReferenceObject

CustomActivityReferenceObject: object
interface

An interface representing CustomActivityReferenceObject. Reference objects for custom activity

Optional datasets

datasets: DatasetReference[]
member

{DatasetReference[]} [datasets] Dataset references.

Optional linkedServices

linkedServices: LinkedServiceReference[]
member

{LinkedServiceReference[]} [linkedServices] Linked service references.

serializedName

serializedName: string = "CustomActivityReferenceObject"

type

type: object

className

className: string = "CustomActivityReferenceObject"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

datasets

datasets: object

serializedName

serializedName: string = "datasets"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DatasetReference"

name

name: "Composite" = "Composite"

linkedServices

linkedServices: object

serializedName

serializedName: string = "linkedServices"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LinkedServiceReference"

name

name: "Composite" = "Composite"

Const CustomDataSourceLinkedService

CustomDataSourceLinkedService: object
interface

An interface representing CustomDataSourceLinkedService. Custom linked service.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

typeProperties

typeProperties: any
member

{any} typeProperties Custom linked service properties.

serializedName

serializedName: string = "CustomDataSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "CustomDataSourceLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

typeProperties

typeProperties: object

required

required: true = true

serializedName

serializedName: string = "typeProperties"

type

type: object

name

name: "Object" = "Object"

Const CustomDataset

CustomDataset: object
interface

An interface representing CustomDataset. The custom dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

typeProperties

typeProperties: any
member

{any} typeProperties Custom dataset properties.

serializedName

serializedName: string = "CustomDataset"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "CustomDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

typeProperties

typeProperties: object

required

required: true = true

serializedName

serializedName: string = "typeProperties"

type

type: object

name

name: "Object" = "Object"

Const DataLakeAnalyticsUSQLActivity

DataLakeAnalyticsUSQLActivity: object
interface

An interface representing DataLakeAnalyticsUSQLActivity. Data Lake Analytics U-SQL activity.

Optional compilationMode

compilationMode: any
member

{any} [compilationMode] Compilation mode of U-SQL. Must be one of these values : Semantic, Full and SingleBox. Type: string (or Expression with resultType string).

Optional degreeOfParallelism

degreeOfParallelism: any
member

{any} [degreeOfParallelism] The maximum number of nodes simultaneously used to run the job. Default value is 1. Type: integer (or Expression with resultType integer), minimum: 1.

Optional dependsOn

dependsOn: ActivityDependency[]
member

{ActivityDependency[]} [dependsOn] Activity depends on condition.

Optional description

description: undefined | string
member

{string} [description] Activity description.

Optional linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} [linkedServiceName] Linked service reference.

name

name: string
member

{string} name Activity name.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: any }} [parameters] Parameters for U-SQL job request.

Optional policy

member

{ActivityPolicy} [policy] Activity policy.

Optional priority

priority: any
member

{any} [priority] Determines which jobs out of all that are queued should be selected to run first. The lower the number, the higher the priority. Default value is 1000. Type: integer (or Expression with resultType integer), minimum: 1.

Optional runtimeVersion

runtimeVersion: any
member

{any} [runtimeVersion] Runtime version of the U-SQL engine to use. Type: string (or Expression with resultType string).

scriptLinkedService

scriptLinkedService: LinkedServiceReference
member

{LinkedServiceReference} scriptLinkedService Script linked service reference.

scriptPath

scriptPath: any
member

{any} scriptPath Case-sensitive path to folder that contains the U-SQL script. Type: string (or Expression with resultType string).

Optional userProperties

userProperties: UserProperty[]
member

{UserProperty[]} [userProperties] Activity user properties.

serializedName

serializedName: string = "DataLakeAnalyticsU-SQL"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Activity.type.additionalProperties

className

className: string = "DataLakeAnalyticsUSQLActivity"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Activity.type.polymorphicDiscriminator

uberParent

uberParent: string = "Activity"

modelProperties

modelProperties: object

compilationMode

compilationMode: object

serializedName

serializedName: string = "typeProperties.compilationMode"

type

type: object

name

name: "Object" = "Object"

degreeOfParallelism

degreeOfParallelism: object

serializedName

serializedName: string = "typeProperties.degreeOfParallelism"

type

type: object

name

name: "Object" = "Object"

parameters

parameters: object

serializedName

serializedName: string = "typeProperties.parameters"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Object" = "Object"

priority

priority: object

serializedName

serializedName: string = "typeProperties.priority"

type

type: object

name

name: "Object" = "Object"

runtimeVersion

runtimeVersion: object

serializedName

serializedName: string = "typeProperties.runtimeVersion"

type

type: object

name

name: "Object" = "Object"

scriptLinkedService

scriptLinkedService: object

defaultValue

defaultValue: object

Type declaration

required

required: true = true

serializedName

serializedName: string = "typeProperties.scriptLinkedService"

type

type: object

className

className: string = "LinkedServiceReference"

name

name: "Composite" = "Composite"

scriptPath

scriptPath: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.scriptPath"

type

type: object

name

name: "Object" = "Object"

Const DatabricksNotebookActivity

DatabricksNotebookActivity: object
interface

An interface representing DatabricksNotebookActivity. DatabricksNotebook activity.

Optional baseParameters

baseParameters: undefined | object
member

{{ [propertyName: string]: any }} [baseParameters] Base parameters to be used for each run of this job.If the notebook takes a parameter that is not specified, the default value from the notebook will be used.

Optional dependsOn

dependsOn: ActivityDependency[]
member

{ActivityDependency[]} [dependsOn] Activity depends on condition.

Optional description

description: undefined | string
member

{string} [description] Activity description.

Optional libraries

libraries: object[]
member

{{ [propertyName: string]: any }[]} [libraries] A list of libraries to be installed on the cluster that will execute the job.

Optional linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} [linkedServiceName] Linked service reference.

name

name: string
member

{string} name Activity name.

notebookPath

notebookPath: any
member

{any} notebookPath The absolute path of the notebook to be run in the Databricks Workspace. This path must begin with a slash. Type: string (or Expression with resultType string).

Optional policy

member

{ActivityPolicy} [policy] Activity policy.

Optional userProperties

userProperties: UserProperty[]
member

{UserProperty[]} [userProperties] Activity user properties.

serializedName

serializedName: string = "DatabricksNotebook"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Activity.type.additionalProperties

className

className: string = "DatabricksNotebookActivity"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Activity.type.polymorphicDiscriminator

uberParent

uberParent: string = "Activity"

modelProperties

modelProperties: object

baseParameters

baseParameters: object

serializedName

serializedName: string = "typeProperties.baseParameters"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Object" = "Object"

libraries

libraries: object

serializedName

serializedName: string = "typeProperties.libraries"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Object" = "Object"

notebookPath

notebookPath: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.notebookPath"

type

type: object

name

name: "Object" = "Object"

Const DatabricksSparkJarActivity

DatabricksSparkJarActivity: object
interface

An interface representing DatabricksSparkJarActivity. DatabricksSparkJar activity.

Optional dependsOn

dependsOn: ActivityDependency[]
member

{ActivityDependency[]} [dependsOn] Activity depends on condition.

Optional description

description: undefined | string
member

{string} [description] Activity description.

Optional libraries

libraries: object[]
member

{{ [propertyName: string]: any }[]} [libraries] A list of libraries to be installed on the cluster that will execute the job.

Optional linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} [linkedServiceName] Linked service reference.

mainClassName

mainClassName: any
member

{any} mainClassName The full name of the class containing the main method to be executed. This class must be contained in a JAR provided as a library. Type: string (or Expression with resultType string).

name

name: string
member

{string} name Activity name.

Optional parameters

parameters: any[]
member

{any[]} [parameters] Parameters that will be passed to the main method.

Optional policy

member

{ActivityPolicy} [policy] Activity policy.

Optional userProperties

userProperties: UserProperty[]
member

{UserProperty[]} [userProperties] Activity user properties.

serializedName

serializedName: string = "DatabricksSparkJar"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Activity.type.additionalProperties

className

className: string = "DatabricksSparkJarActivity"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Activity.type.polymorphicDiscriminator

uberParent

uberParent: string = "Activity"

modelProperties

modelProperties: object

libraries

libraries: object

serializedName

serializedName: string = "typeProperties.libraries"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Object" = "Object"

mainClassName

mainClassName: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.mainClassName"

type

type: object

name

name: "Object" = "Object"

parameters

parameters: object

serializedName

serializedName: string = "typeProperties.parameters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "Object" = "Object"

Const DatabricksSparkPythonActivity

DatabricksSparkPythonActivity: object
interface

An interface representing DatabricksSparkPythonActivity. DatabricksSparkPython activity.

Optional dependsOn

dependsOn: ActivityDependency[]
member

{ActivityDependency[]} [dependsOn] Activity depends on condition.

Optional description

description: undefined | string
member

{string} [description] Activity description.

Optional libraries

libraries: object[]
member

{{ [propertyName: string]: any }[]} [libraries] A list of libraries to be installed on the cluster that will execute the job.

Optional linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} [linkedServiceName] Linked service reference.

name

name: string
member

{string} name Activity name.

Optional parameters

parameters: any[]
member

{any[]} [parameters] Command line parameters that will be passed to the Python file.

Optional policy

member

{ActivityPolicy} [policy] Activity policy.

pythonFile

pythonFile: any
member

{any} pythonFile The URI of the Python file to be executed. DBFS paths are supported. Type: string (or Expression with resultType string).

Optional userProperties

userProperties: UserProperty[]
member

{UserProperty[]} [userProperties] Activity user properties.

serializedName

serializedName: string = "DatabricksSparkPython"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Activity.type.additionalProperties

className

className: string = "DatabricksSparkPythonActivity"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Activity.type.polymorphicDiscriminator

uberParent

uberParent: string = "Activity"

modelProperties

modelProperties: object

libraries

libraries: object

serializedName

serializedName: string = "typeProperties.libraries"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Object" = "Object"

parameters

parameters: object

serializedName

serializedName: string = "typeProperties.parameters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "Object" = "Object"

pythonFile

pythonFile: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.pythonFile"

type

type: object

name

name: "Object" = "Object"

Const Dataset

Dataset: object
interface

An interface representing Dataset. The Azure Data Factory nested object which identifies data within different data stores, such as tables, files, folders, and documents.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

serializedName

serializedName: string = "Dataset"

type

type: object
member

{string} type Polymorphic Discriminator

className

className: string = "Dataset"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "Dataset"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

modelProperties

modelProperties: object

annotations

annotations: object

serializedName

serializedName: string = "annotations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "Object" = "Object"

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

folder

folder: object

serializedName

serializedName: string = "folder"

type

type: object

className

className: string = "DatasetFolder"

name

name: "Composite" = "Composite"

linkedServiceName

linkedServiceName: object

defaultValue

defaultValue: object

Type declaration

required

required: true = true

serializedName

serializedName: string = "linkedServiceName"

type

type: object

className

className: string = "LinkedServiceReference"

name

name: "Composite" = "Composite"

parameters

parameters: object

serializedName

serializedName: string = "parameters"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

className

className: string = "ParameterSpecification"

name

name: "Composite" = "Composite"

structure

structure: object

serializedName

serializedName: string = "structure"

type

type: object

name

name: "Object" = "Object"

type

type: object

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "type"

serializedName

serializedName: string = "type"

Const DatasetBZip2Compression

DatasetBZip2Compression: object
interface

An interface representing DatasetBZip2Compression. The BZip2 compression method used on a dataset.

serializedName

serializedName: string = "BZip2"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = DatasetCompression.type.additionalProperties

className

className: string = "DatasetBZip2Compression"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = DatasetCompression.type.polymorphicDiscriminator

uberParent

uberParent: string = "DatasetCompression"

modelProperties

modelProperties: object

Const DatasetCompression

DatasetCompression: object
interface

An interface representing DatasetCompression. The compression method used on a dataset.

serializedName

serializedName: string = "DatasetCompression"

type

type: object
member

{string} type Polymorphic Discriminator

className

className: string = "DatasetCompression"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "DatasetCompression"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

modelProperties

modelProperties: object

type

type: object

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "type"

serializedName

serializedName: string = "type"

Const DatasetDeflateCompression

DatasetDeflateCompression: object
interface

An interface representing DatasetDeflateCompression. The Deflate compression method used on a dataset.

Optional level

member

{DatasetCompressionLevel} [level] The Deflate compression level. Possible values include: 'Optimal', 'Fastest'

serializedName

serializedName: string = "Deflate"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = DatasetCompression.type.additionalProperties

className

className: string = "DatasetDeflateCompression"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = DatasetCompression.type.polymorphicDiscriminator

uberParent

uberParent: string = "DatasetCompression"

modelProperties

modelProperties: object

level

level: object

serializedName

serializedName: string = "level"

type

type: object

name

name: "String" = "String"

Const DatasetFolder

DatasetFolder: object
interface

An interface representing DatasetFolder. The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

Optional name

name: undefined | string
member

{string} [name] The name of the folder that this Dataset is in.

serializedName

serializedName: string = "Dataset_folder"

type

type: object

className

className: string = "DatasetFolder"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const DatasetGZipCompression

DatasetGZipCompression: object
interface

An interface representing DatasetGZipCompression. The GZip compression method used on a dataset.

Optional level

member

{DatasetCompressionLevel} [level] The GZip compression level. Possible values include: 'Optimal', 'Fastest'

serializedName

serializedName: string = "GZip"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = DatasetCompression.type.additionalProperties

className

className: string = "DatasetGZipCompression"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = DatasetCompression.type.polymorphicDiscriminator

uberParent

uberParent: string = "DatasetCompression"

modelProperties

modelProperties: object

level

level: object

serializedName

serializedName: string = "level"

type

type: object

name

name: "String" = "String"

Const DatasetListResponse

DatasetListResponse: object
interface

An interface representing the DatasetListResponse. A list of dataset resources.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] The link to the next page of results, if any remaining results exist.

serializedName

serializedName: string = "DatasetListResponse"

__@iterator

  • Iterator

    Returns IterableIterator<DatasetResource>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<DatasetResource>[]

      Additional items to add to the end of array1.

    Returns DatasetResource[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns DatasetResource[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, DatasetResource]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: DatasetResource, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: DatasetResource

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): DatasetResource[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns DatasetResource[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): DatasetResource | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns DatasetResource | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: DatasetResource, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: DatasetResource

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: DatasetResource, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: DatasetResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: DatasetResource, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: DatasetResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns DatasetResource | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns DatasetResource

  • Parameters

    Returns DatasetResource

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns DatasetResource

  • Parameters

    Returns DatasetResource

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns DatasetResource[]

shift

  • Removes the first element from an array and returns it.

    Returns DatasetResource | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): DatasetResource[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns DatasetResource[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns DatasetResource[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: DatasetResource[]

      Elements to insert into the array in place of the deleted elements.

    Returns DatasetResource[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: DatasetResource[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<DatasetResource>

type

type: object

className

className: string = "DatasetListResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DatasetResource"

name

name: "Composite" = "Composite"

Const DatasetReference

DatasetReference: object
interface

An interface representing DatasetReference. Dataset reference type.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: any }} [parameters] Arguments for dataset.

referenceName

referenceName: string
member

{string} referenceName Reference dataset name.

serializedName

serializedName: string = "DatasetReference"

type

type: object

className

className: string = "DatasetReference"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

parameters

parameters: object

serializedName

serializedName: string = "parameters"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Object" = "Object"

referenceName

referenceName: object

required

required: true = true

serializedName

serializedName: string = "referenceName"

type

type: object

name

name: "String" = "String"

type

type: object

defaultValue

defaultValue: string = "DatasetReference"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const DatasetResource

DatasetResource: object
interface

An interface representing DatasetResource. Dataset resource type.

extends

SubResource

Optional etag

etag: undefined | string
member

{string} [etag] Etag identifies change in the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string
member

{string} [id] The resource identifier. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string
member

{string} [name] The resource name. NOTE: This property will not be serialized. It can only be populated by the server.

properties

properties: DatasetUnion
member

{DatasetUnion} properties Dataset properties.

serializedName

serializedName: string = "DatasetResource"

Optional type

type: object
member

{string} [type] The resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "DatasetResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

defaultValue

defaultValue: object

Type declaration

required

required: true = true

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "Dataset"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

Const DatasetStorageFormat

DatasetStorageFormat: object
interface

An interface representing DatasetStorageFormat. The format definition of a storage.

Optional deserializer

deserializer: any
member

{any} [deserializer] Deserializer. Type: string (or Expression with resultType string).

Optional serializer

serializer: any
member

{any} [serializer] Serializer. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "DatasetStorageFormat"

type

type: object
member

{string} type Polymorphic Discriminator

className

className: string = "DatasetStorageFormat"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "DatasetStorageFormat"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

modelProperties

modelProperties: object

deserializer

deserializer: object

serializedName

serializedName: string = "deserializer"

type

type: object

name

name: "Object" = "Object"

serializer

serializer: object

serializedName

serializedName: string = "serializer"

type

type: object

name

name: "Object" = "Object"

type

type: object

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "type"

serializedName

serializedName: string = "type"

Const DatasetZipDeflateCompression

DatasetZipDeflateCompression: object
interface

An interface representing DatasetZipDeflateCompression. The ZipDeflate compression method used on a dataset.

Optional level

member

{DatasetCompressionLevel} [level] The ZipDeflate compression level. Possible values include: 'Optimal', 'Fastest'

serializedName

serializedName: string = "ZipDeflate"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = DatasetCompression.type.additionalProperties

className

className: string = "DatasetZipDeflateCompression"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = DatasetCompression.type.polymorphicDiscriminator

uberParent

uberParent: string = "DatasetCompression"

modelProperties

modelProperties: object

level

level: object

serializedName

serializedName: string = "level"

type

type: object

name

name: "String" = "String"

Const Db2LinkedService

Db2LinkedService: object
interface

An interface representing Db2LinkedService. Linked service for DB2 data source.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional authenticationType

authenticationType: Db2AuthenticationType
member

{Db2AuthenticationType} [authenticationType] AuthenticationType to be used for connection. Possible values include: 'Basic'

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

database

database: any
member

{any} database Database name for connection. Type: string (or Expression with resultType string).

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional password

password: SecretBaseUnion
member

{SecretBaseUnion} [password] Password for authentication.

server

server: any
member

{any} server Server name for connection. Type: string (or Expression with resultType string).

Optional username

username: any
member

{any} [username] Username for authentication. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "Db2"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "Db2LinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

authenticationType

authenticationType: object

serializedName

serializedName: string = "typeProperties.authenticationType"

type

type: object

name

name: "String" = "String"

database

database: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.database"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

password

password: object

serializedName

serializedName: string = "typeProperties.password"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

server

server: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.server"

type

type: object

name

name: "Object" = "Object"

username

username: object

serializedName

serializedName: string = "typeProperties.username"

type

type: object

name

name: "Object" = "Object"

Const DeleteActivity

DeleteActivity: object
interface

An interface representing DeleteActivity. Delete activity.

dataset

member

{DatasetReference} dataset Delete activity dataset reference.

Optional dependsOn

dependsOn: ActivityDependency[]
member

{ActivityDependency[]} [dependsOn] Activity depends on condition.

Optional description

description: undefined | string
member

{string} [description] Activity description.

Optional linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} [linkedServiceName] Linked service reference.

name

name: string
member

{string} name Activity name.

Optional policy

member

{ActivityPolicy} [policy] Activity policy.

Optional recursive

recursive: any
member

{any} [recursive] If true, files under the folder path will be deleted recursively. Default is true. Type: boolean (or Expression with resultType boolean).

Optional userProperties

userProperties: UserProperty[]
member

{UserProperty[]} [userProperties] Activity user properties.

serializedName

serializedName: string = "Delete"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Activity.type.additionalProperties

className

className: string = "DeleteActivity"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Activity.type.polymorphicDiscriminator

uberParent

uberParent: string = "Activity"

modelProperties

modelProperties: object

dataset

dataset: object

defaultValue

defaultValue: object

Type declaration

required

required: true = true

serializedName

serializedName: string = "typeProperties.dataset"

type

type: object

className

className: string = "DatasetReference"

name

name: "Composite" = "Composite"

recursive

recursive: object

serializedName

serializedName: string = "typeProperties.recursive"

type

type: object

name

name: "Object" = "Object"

Const DependencyReference

DependencyReference: object
interface

An interface representing DependencyReference. Referenced dependency.

serializedName

serializedName: string = "DependencyReference"

type

type: object
member

{string} type Polymorphic Discriminator

className

className: string = "DependencyReference"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "DependencyReference"

modelProperties

modelProperties: object

type

type: object

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "type"

serializedName

serializedName: string = "type"

Const DistcpSettings

DistcpSettings: object
interface

An interface representing DistcpSettings. Distcp settings.

Optional distcpOptions

distcpOptions: any
member

{any} [distcpOptions] Specifies the Distcp options. Type: string (or Expression with resultType string).

resourceManagerEndpoint

resourceManagerEndpoint: any
member

{any} resourceManagerEndpoint Specifies the Yarn ResourceManager endpoint. Type: string (or Expression with resultType string).

tempScriptPath

tempScriptPath: any
member

{any} tempScriptPath Specifies an existing folder path which will be used to store temp Distcp command script. The script file is generated by ADF and will be removed after Copy job finished. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "DistcpSettings"

type

type: object

className

className: string = "DistcpSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

distcpOptions

distcpOptions: object

serializedName

serializedName: string = "distcpOptions"

type

type: object

name

name: "Object" = "Object"

resourceManagerEndpoint

resourceManagerEndpoint: object

required

required: true = true

serializedName

serializedName: string = "resourceManagerEndpoint"

type

type: object

name

name: "Object" = "Object"

tempScriptPath

tempScriptPath: object

required

required: true = true

serializedName

serializedName: string = "tempScriptPath"

type

type: object

name

name: "Object" = "Object"

Const DocumentDbCollectionDataset

DocumentDbCollectionDataset: object
interface

An interface representing DocumentDbCollectionDataset. Microsoft Azure Document Database Collection dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

collectionName

collectionName: any
member

{any} collectionName Document Database collection name. Type: string (or Expression with resultType string).

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

serializedName

serializedName: string = "DocumentDbCollection"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "DocumentDbCollectionDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

collectionName

collectionName: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.collectionName"

type

type: object

name

name: "Object" = "Object"

Const DocumentDbCollectionSink

DocumentDbCollectionSink: object
interface

An interface representing DocumentDbCollectionSink. A copy activity Document Database Collection sink.

Optional nestingSeparator

nestingSeparator: any
member

{any} [nestingSeparator] Nested properties separator. Default is . (dot). Type: string (or Expression with resultType string).

Optional sinkRetryCount

sinkRetryCount: any
member

{any} [sinkRetryCount] Sink retry count. Type: integer (or Expression with resultType integer).

Optional sinkRetryWait

sinkRetryWait: any
member

{any} [sinkRetryWait] Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Optional writeBatchSize

writeBatchSize: any
member

{any} [writeBatchSize] Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

Optional writeBatchTimeout

writeBatchTimeout: any
member

{any} [writeBatchTimeout] Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "DocumentDbCollectionSink"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySink.type.additionalProperties

className

className: string = "DocumentDbCollectionSink"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySink.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySink"

modelProperties

modelProperties: object

nestingSeparator

nestingSeparator: object

serializedName

serializedName: string = "nestingSeparator"

type

type: object

name

name: "Object" = "Object"

Const DocumentDbCollectionSource

DocumentDbCollectionSource: object
interface

An interface representing DocumentDbCollectionSource. A copy activity Document Database Collection source.

Optional nestingSeparator

nestingSeparator: any
member

{any} [nestingSeparator] Nested properties separator. Type: string (or Expression with resultType string).

Optional query

query: any
member

{any} [query] Documents query. Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "DocumentDbCollectionSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "DocumentDbCollectionSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

nestingSeparator

nestingSeparator: object

serializedName

serializedName: string = "nestingSeparator"

type

type: object

name

name: "Object" = "Object"

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

Const DrillLinkedService

DrillLinkedService: object
interface

An interface representing DrillLinkedService. Drill server linked service.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional connectionString

connectionString: any
member

{any} [connectionString] An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional pwd

member

{AzureKeyVaultSecretReference} [pwd] The Azure key vault secret reference of password in connection string.

serializedName

serializedName: string = "Drill"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "DrillLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

connectionString

connectionString: object

serializedName

serializedName: string = "typeProperties.connectionString"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

pwd

pwd: object

serializedName

serializedName: string = "typeProperties.pwd"

type

type: object

className

className: string = "AzureKeyVaultSecretReference"

name

name: "Composite" = "Composite"

Const DrillSource

DrillSource: object
interface

An interface representing DrillSource. A copy activity Drill server source.

Optional query

query: any
member

{any} [query] A query to retrieve data from source. Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "DrillSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "DrillSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

Const DrillTableDataset

DrillTableDataset: object
interface

An interface representing DrillTableDataset. Drill server dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Optional tableName

tableName: any
member

{any} [tableName] The table name. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "DrillTable"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "DrillTableDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

tableName

tableName: object

serializedName

serializedName: string = "typeProperties.tableName"

type

type: object

name

name: "Object" = "Object"

Const DynamicsEntityDataset

DynamicsEntityDataset: object
interface

An interface representing DynamicsEntityDataset. The Dynamics entity dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional entityName

entityName: any
member

{any} [entityName] The logical name of the entity. Type: string (or Expression with resultType string).

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

serializedName

serializedName: string = "DynamicsEntity"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "DynamicsEntityDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

entityName

entityName: object

serializedName

serializedName: string = "typeProperties.entityName"

type

type: object

name

name: "Object" = "Object"

Const DynamicsLinkedService

DynamicsLinkedService: object
interface

An interface representing DynamicsLinkedService. Dynamics linked service.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

authenticationType

authenticationType: any
member

{any} authenticationType The authentication type to connect to Dynamics server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario. Type: string (or Expression with resultType string).

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

deploymentType

deploymentType: any
member

{any} deploymentType The deployment type of the Dynamics instance. 'Online' for Dynamics Online and 'OnPremisesWithIfd' for Dynamics on-premises with Ifd. Type: string (or Expression with resultType string).

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional hostName

hostName: any
member

{any} [hostName] The host name of the on-premises Dynamics server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string).

Optional organizationName

organizationName: any
member

{any} [organizationName] The organization name of the Dynamics instance. The property is required for on-prem and required for online when there are more than one Dynamics instances associated with the user. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional password

password: SecretBaseUnion
member

{SecretBaseUnion} [password] Password to access the Dynamics instance.

Optional port

port: any
member

{any} [port] The port of on-premises Dynamics server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0.

Optional serviceUri

serviceUri: any
member

{any} [serviceUri] The URL to the Microsoft Dynamics server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string).

username

username: any
member

{any} username User name to access the Dynamics instance. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "Dynamics"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "DynamicsLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

authenticationType

authenticationType: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.authenticationType"

type

type: object

name

name: "Object" = "Object"

deploymentType

deploymentType: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.deploymentType"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

hostName

hostName: object

serializedName

serializedName: string = "typeProperties.hostName"

type

type: object

name

name: "Object" = "Object"

organizationName

organizationName: object

serializedName

serializedName: string = "typeProperties.organizationName"

type

type: object

name

name: "Object" = "Object"

password

password: object

serializedName

serializedName: string = "typeProperties.password"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

port

port: object

serializedName

serializedName: string = "typeProperties.port"

type

type: object

name

name: "Object" = "Object"

serviceUri

serviceUri: object

serializedName

serializedName: string = "typeProperties.serviceUri"

type

type: object

name

name: "Object" = "Object"

username

username: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.username"

type

type: object

name

name: "Object" = "Object"

Const DynamicsSink

DynamicsSink: object
interface

An interface representing DynamicsSink. A copy activity Dynamics sink.

Optional ignoreNullValues

ignoreNullValues: any
member

{any} [ignoreNullValues] The flag indicating whether ignore null values from input dataset (except key fields) during write operation. Default is false. Type: boolean (or Expression with resultType boolean).

Optional sinkRetryCount

sinkRetryCount: any
member

{any} [sinkRetryCount] Sink retry count. Type: integer (or Expression with resultType integer).

Optional sinkRetryWait

sinkRetryWait: any
member

{any} [sinkRetryWait] Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Optional writeBatchSize

writeBatchSize: any
member

{any} [writeBatchSize] Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

Optional writeBatchTimeout

writeBatchTimeout: any
member

{any} [writeBatchTimeout] Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "DynamicsSink"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySink.type.additionalProperties

className

className: string = "DynamicsSink"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySink.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySink"

modelProperties

modelProperties: object

ignoreNullValues

ignoreNullValues: object

serializedName

serializedName: string = "ignoreNullValues"

type

type: object

name

name: "Object" = "Object"

writeBehavior

writeBehavior: object

defaultValue

defaultValue: string = "Upsert"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "writeBehavior"

type

type: object

name

name: "String" = "String"

Const DynamicsSource

DynamicsSource: object
interface

An interface representing DynamicsSource. A copy activity Dynamics source.

Optional query

query: any
member

{any} [query] FetchXML is a proprietary query language that is used in Microsoft Dynamics (online & on-premises). Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "DynamicsSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "DynamicsSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

Const EloquaLinkedService

EloquaLinkedService: object
interface

An interface representing EloquaLinkedService. Eloqua server linked service.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

endpoint

endpoint: any
member

{any} endpoint The endpoint of the Eloqua server. (i.e. eloqua.example.com)

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional password

password: SecretBaseUnion
member

{SecretBaseUnion} [password] The password corresponding to the user name.

Optional useEncryptedEndpoints

useEncryptedEndpoints: any
member

{any} [useEncryptedEndpoints] Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

Optional useHostVerification

useHostVerification: any
member

{any} [useHostVerification] Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.

Optional usePeerVerification

usePeerVerification: any
member

{any} [usePeerVerification] Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

username

username: any
member

{any} username The site name and user name of your Eloqua account in the form: sitename/username. (i.e. Eloqua/Alice)

serializedName

serializedName: string = "Eloqua"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "EloquaLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

endpoint

endpoint: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.endpoint"

type

type: object

name

name: "Object" = "Object"

password

password: object

serializedName

serializedName: string = "typeProperties.password"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

useEncryptedEndpoints

useEncryptedEndpoints: object

serializedName

serializedName: string = "typeProperties.useEncryptedEndpoints"

type

type: object

name

name: "Object" = "Object"

useHostVerification

useHostVerification: object

serializedName

serializedName: string = "typeProperties.useHostVerification"

type

type: object

name

name: "Object" = "Object"

usePeerVerification

usePeerVerification: object

serializedName

serializedName: string = "typeProperties.usePeerVerification"

type

type: object

name

name: "Object" = "Object"

username

username: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.username"

type

type: object

name

name: "Object" = "Object"

Const EloquaObjectDataset

EloquaObjectDataset: object
interface

An interface representing EloquaObjectDataset. Eloqua server dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Optional tableName

tableName: any
member

{any} [tableName] The table name. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "EloquaObject"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "EloquaObjectDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

tableName

tableName: object

serializedName

serializedName: string = "typeProperties.tableName"

type

type: object

name

name: "Object" = "Object"

Const EloquaSource

EloquaSource: object
interface

An interface representing EloquaSource. A copy activity Eloqua server source.

Optional query

query: any
member

{any} [query] A query to retrieve data from source. Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "EloquaSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "EloquaSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

Const ExecutePipelineActivity

ExecutePipelineActivity: object
interface

An interface representing ExecutePipelineActivity. Execute pipeline activity.

Optional dependsOn

dependsOn: ActivityDependency[]
member

{ActivityDependency[]} [dependsOn] Activity depends on condition.

Optional description

description: undefined | string
member

{string} [description] Activity description.

name

name: string
member

{string} name Activity name.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: any }} [parameters] Pipeline parameters.

pipelineProperty

pipelineProperty: PipelineReference
member

{PipelineReference} pipelineProperty Pipeline reference.

Optional userProperties

userProperties: UserProperty[]
member

{UserProperty[]} [userProperties] Activity user properties.

Optional waitOnCompletion

waitOnCompletion: undefined | false | true
member

{boolean} [waitOnCompletion] Defines whether activity execution will wait for the dependent pipeline execution to finish. Default is false.

serializedName

serializedName: string = "ExecutePipeline"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Activity.type.additionalProperties

className

className: string = "ExecutePipelineActivity"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Activity.type.polymorphicDiscriminator

uberParent

uberParent: string = "Activity"

modelProperties

modelProperties: object

parameters

parameters: object

serializedName

serializedName: string = "typeProperties.parameters"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Object" = "Object"

pipelineProperty

pipelineProperty: object

defaultValue

defaultValue: object

Type declaration

required

required: true = true

serializedName

serializedName: string = "typeProperties.pipeline"

type

type: object

className

className: string = "PipelineReference"

name

name: "Composite" = "Composite"

waitOnCompletion

waitOnCompletion: object

serializedName

serializedName: string = "typeProperties.waitOnCompletion"

type

type: object

name

name: "Boolean" = "Boolean"

Const ExecuteSSISPackageActivity

ExecuteSSISPackageActivity: object
interface

An interface representing ExecuteSSISPackageActivity. Execute SSIS package activity.

connectVia

member

{IntegrationRuntimeReference} connectVia The integration runtime reference.

Optional dependsOn

dependsOn: ActivityDependency[]
member

{ActivityDependency[]} [dependsOn] Activity depends on condition.

Optional description

description: undefined | string
member

{string} [description] Activity description.

Optional environmentPath

environmentPath: undefined | string
member

{string} [environmentPath] The environment path to execute the SSIS package.

Optional linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} [linkedServiceName] Linked service reference.

Optional loggingLevel

loggingLevel: undefined | string
member

{string} [loggingLevel] The logging level of SSIS package execution.

name

name: string
member

{string} name Activity name.

Optional packageConnectionManagers

packageConnectionManagers: undefined | object
member

{{ [propertyName: string]: { [propertyName: string]: SSISExecutionParameter } }} [packageConnectionManagers] The package level connection managers to execute the SSIS package.

packageLocation

packageLocation: SSISPackageLocation
member

{SSISPackageLocation} packageLocation SSIS package location.

Optional packageParameters

packageParameters: undefined | object
member

{{ [propertyName: string]: SSISExecutionParameter }} [packageParameters] The package level parameters to execute the SSIS package.

Optional policy

member

{ActivityPolicy} [policy] Activity policy.

Optional projectConnectionManagers

projectConnectionManagers: undefined | object
member

{{ [propertyName: string]: { [propertyName: string]: SSISExecutionParameter } }} [projectConnectionManagers] The project level connection managers to execute the SSIS package.

Optional projectParameters

projectParameters: undefined | object
member

{{ [propertyName: string]: SSISExecutionParameter }} [projectParameters] The project level parameters to execute the SSIS package.

Optional propertyOverrides

propertyOverrides: undefined | object
member

{{ [propertyName: string]: SSISPropertyOverride }} [propertyOverrides] The property overrides to execute the SSIS package.

Optional runtime

member

{SSISExecutionRuntime} [runtime] Specifies the runtime to execute SSIS package. Possible values include: 'x64', 'x86'

Optional userProperties

userProperties: UserProperty[]
member

{UserProperty[]} [userProperties] Activity user properties.

serializedName

serializedName: string = "ExecuteSSISPackage"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Activity.type.additionalProperties

className

className: string = "ExecuteSSISPackageActivity"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Activity.type.polymorphicDiscriminator

uberParent

uberParent: string = "Activity"

modelProperties

modelProperties: object

connectVia

connectVia: object

defaultValue

defaultValue: object

Type declaration

required

required: true = true

serializedName

serializedName: string = "typeProperties.connectVia"

type

type: object

className

className: string = "IntegrationRuntimeReference"

name

name: "Composite" = "Composite"

environmentPath

environmentPath: object

serializedName

serializedName: string = "typeProperties.environmentPath"

type

type: object

name

name: "String" = "String"

loggingLevel

loggingLevel: object

serializedName

serializedName: string = "typeProperties.loggingLevel"

type

type: object

name

name: "String" = "String"

packageConnectionManagers

packageConnectionManagers: object

serializedName

serializedName: string = "typeProperties.packageConnectionManagers"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

className

className: string = "SSISExecutionParameter"

name

name: "Composite" = "Composite"

packageLocation

packageLocation: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.packageLocation"

type

type: object

className

className: string = "SSISPackageLocation"

name

name: "Composite" = "Composite"

packageParameters

packageParameters: object

serializedName

serializedName: string = "typeProperties.packageParameters"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

className

className: string = "SSISExecutionParameter"

name

name: "Composite" = "Composite"

projectConnectionManagers

projectConnectionManagers: object

serializedName

serializedName: string = "typeProperties.projectConnectionManagers"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

className

className: string = "SSISExecutionParameter"

name

name: "Composite" = "Composite"

projectParameters

projectParameters: object

serializedName

serializedName: string = "typeProperties.projectParameters"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

className

className: string = "SSISExecutionParameter"

name

name: "Composite" = "Composite"

propertyOverrides

propertyOverrides: object

serializedName

serializedName: string = "typeProperties.propertyOverrides"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

className

className: string = "SSISPropertyOverride"

name

name: "Composite" = "Composite"

runtime

runtime: object

serializedName

serializedName: string = "typeProperties.runtime"

type

type: object

name

name: "String" = "String"

Const ExecutionActivity

ExecutionActivity: object
interface

An interface representing ExecutionActivity. Base class for all execution activities.

Optional dependsOn

dependsOn: ActivityDependency[]
member

{ActivityDependency[]} [dependsOn] Activity depends on condition.

Optional description

description: undefined | string
member

{string} [description] Activity description.

Optional linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} [linkedServiceName] Linked service reference.

name

name: string
member

{string} name Activity name.

Optional policy

member

{ActivityPolicy} [policy] Activity policy.

Optional userProperties

userProperties: UserProperty[]
member

{UserProperty[]} [userProperties] Activity user properties.

serializedName

serializedName: string = "Execution"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Activity.type.additionalProperties

className

className: string = "ExecutionActivity"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Activity.type.polymorphicDiscriminator

uberParent

uberParent: string = "Activity"

modelProperties

modelProperties: object

linkedServiceName

linkedServiceName: object

serializedName

serializedName: string = "linkedServiceName"

type

type: object

className

className: string = "LinkedServiceReference"

name

name: "Composite" = "Composite"

policy

policy: object

serializedName

serializedName: string = "policy"

type

type: object

className

className: string = "ActivityPolicy"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

Const Expression

Expression: object
interface

An interface representing Expression. Azure Data Factory expression definition.

value

value: string
member

{string} value Expression value.

serializedName

serializedName: string = "Expression"

type

type: object

className

className: string = "Expression"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

type

type: object

defaultValue

defaultValue: string = "Expression"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const Factory

Factory: object
interface

An interface representing Factory. Factory resource type.

extends

Resource

Optional createTime

createTime: Date
member

{Date} [createTime] Time the factory was created in ISO8601 format. NOTE: This property will not be serialized. It can only be populated by the server.

Optional eTag

eTag: undefined | string
member

{string} [eTag] Etag identifies change in the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string
member

{string} [id] The resource identifier. NOTE: This property will not be serialized. It can only be populated by the server.

Optional identity

identity: FactoryIdentity
member

{FactoryIdentity} [identity] Managed service identity of the factory.

Optional location

location: undefined | string
member

{string} [location] The resource location.

Optional name

name: undefined | string
member

{string} [name] The resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string
member

{string} [provisioningState] Factory provisioning state, example Succeeded. NOTE: This property will not be serialized. It can only be populated by the server.

Optional repoConfiguration

member

{FactoryRepoConfigurationUnion} [repoConfiguration] Git repo information of the factory.

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] The resource tags.

Optional version

version: undefined | string
member

{string} [version] Version of the factory. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Factory"

Optional type

type: object
member

{string} [type] The resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Factory"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

modelProperties

modelProperties: object

createTime

createTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.createTime"

type

type: object

name

name: "DateTime" = "DateTime"

identity

identity: object

serializedName

serializedName: string = "identity"

type

type: object

className

className: string = "FactoryIdentity"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

repoConfiguration

repoConfiguration: object

serializedName

serializedName: string = "properties.repoConfiguration"

type

type: object

className

className: string = "FactoryRepoConfiguration"

name

name: "Composite" = "Composite"

version

version: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.version"

type

type: object

name

name: "String" = "String"

Const FactoryGitHubConfiguration

FactoryGitHubConfiguration: object
interface

An interface representing FactoryGitHubConfiguration. Factory's GitHub repo information.

accountName

accountName: string
member

{string} accountName Account name.

collaborationBranch

collaborationBranch: string
member

{string} collaborationBranch Collaboration branch.

Optional hostName

hostName: undefined | string
member

{string} [hostName] GitHub Enterprise host name. For example: https://github.mydomain.com

Optional lastCommitId

lastCommitId: undefined | string
member

{string} [lastCommitId] Last commit id.

repositoryName

repositoryName: string
member

{string} repositoryName Rrepository name.

rootFolder

rootFolder: string
member

{string} rootFolder Root folder.

serializedName

serializedName: string = "FactoryGitHubConfiguration"

type

type: object
member

{string} type Polymorphic Discriminator

className

className: string = "FactoryGitHubConfiguration"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FactoryRepoConfiguration.type.polymorphicDiscriminator

uberParent

uberParent: string = "FactoryRepoConfiguration"

modelProperties

modelProperties: object

hostName

hostName: object

serializedName

serializedName: string = "hostName"

type

type: object

name

name: "String" = "String"

Const FactoryIdentity

FactoryIdentity: object
interface

An interface representing FactoryIdentity. Identity properties of the factory resource.

Optional principalId

principalId: undefined | string
member

{string} [principalId] The principal id of the identity. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tenantId

tenantId: undefined | string
member

{string} [tenantId] The client tenant id of the identity. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "FactoryIdentity"

type

type: object

className

className: string = "FactoryIdentity"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

principalId

principalId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "principalId"

type

type: object

name

name: "Uuid" = "Uuid"

tenantId

tenantId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "tenantId"

type

type: object

name

name: "Uuid" = "Uuid"

type

type: object

defaultValue

defaultValue: string = "SystemAssigned"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const FactoryListResponse

FactoryListResponse: object
interface

An interface representing the FactoryListResponse. A list of factory resources.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] The link to the next page of results, if any remaining results exist.

serializedName

serializedName: string = "FactoryListResponse"

__@iterator

  • __@iterator(): IterableIterator<Factory>
  • Iterator

    Returns IterableIterator<Factory>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Factory>[]): Factory[]
  • concat(...items: (T | ConcatArray<T>)[]): Factory[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Factory>[]

      Additional items to add to the end of array1.

    Returns Factory[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Factory[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Factory]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Factory]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Factory, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Factory

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Factory[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Factory[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Factory | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Factory, index: number, obj: Factory[]): boolean
        • Parameters

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
    • Optional thisArg: any

    Returns Factory | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Factory, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Factory

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Factory, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Factory

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Factory, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Factory

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns Factory | undefined

push

  • push(...items: Factory[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Factory[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Factory
  • reduce(callbackfn: function, initialValue: Factory): Factory
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns Factory

  • Parameters

    Returns Factory

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Factory, currentIndex: number, array: Factory[]): U
        • Parameters

          • previousValue: U
          • currentValue: Factory
          • currentIndex: number
          • array: Factory[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Factory
  • reduceRight(callbackfn: function, initialValue: Factory): Factory
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns Factory

  • Parameters

    Returns Factory

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Factory, currentIndex: number, array: Factory[]): U
        • Parameters

          • previousValue: U
          • currentValue: Factory
          • currentIndex: number
          • array: Factory[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns Factory[]

shift

  • Removes the first element from an array and returns it.

    Returns Factory | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Factory[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Factory[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Factory[]
  • splice(start: number, deleteCount: number, ...items: Factory[]): Factory[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Factory[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Factory[]

      Elements to insert into the array in place of the deleted elements.

    Returns Factory[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Factory[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Factory[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Factory>
  • Returns an iterable of values in the array

    Returns IterableIterator<Factory>

type

type: object

className

className: string = "FactoryListResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Factory"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

Const FactoryRepoConfiguration

FactoryRepoConfiguration: object
interface

An interface representing FactoryRepoConfiguration. Factory's git repo information.

accountName

accountName: string
member

{string} accountName Account name.

collaborationBranch

collaborationBranch: string
member

{string} collaborationBranch Collaboration branch.

Optional lastCommitId

lastCommitId: undefined | string
member

{string} [lastCommitId] Last commit id.

repositoryName

repositoryName: string
member

{string} repositoryName Rrepository name.

rootFolder

rootFolder: string
member

{string} rootFolder Root folder.

serializedName

serializedName: string = "FactoryRepoConfiguration"

type

type: object
member

{string} type Polymorphic Discriminator

className

className: string = "FactoryRepoConfiguration"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "FactoryRepoConfiguration"

modelProperties

modelProperties: object

accountName

accountName: object

required

required: true = true

serializedName

serializedName: string = "accountName"

type

type: object

name

name: "String" = "String"

collaborationBranch

collaborationBranch: object

required

required: true = true

serializedName

serializedName: string = "collaborationBranch"

type

type: object

name

name: "String" = "String"

lastCommitId

lastCommitId: object

serializedName

serializedName: string = "lastCommitId"

type

type: object

name

name: "String" = "String"

repositoryName

repositoryName: object

required

required: true = true

serializedName

serializedName: string = "repositoryName"

type

type: object

name

name: "String" = "String"

rootFolder

rootFolder: object

required

required: true = true

serializedName

serializedName: string = "rootFolder"

type

type: object

name

name: "String" = "String"

type

type: object

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "type"

serializedName

serializedName: string = "type"

Const FactoryRepoUpdate

FactoryRepoUpdate: object
interface

An interface representing FactoryRepoUpdate. Factory's git repo information.

Optional factoryResourceId

factoryResourceId: undefined | string
member

{string} [factoryResourceId] The factory resource id.

Optional repoConfiguration

member

{FactoryRepoConfigurationUnion} [repoConfiguration] Git repo information of the factory.

serializedName

serializedName: string = "FactoryRepoUpdate"

type

type: object

className

className: string = "FactoryRepoUpdate"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

factoryResourceId

factoryResourceId: object

serializedName

serializedName: string = "factoryResourceId"

type

type: object

name

name: "String" = "String"

repoConfiguration

repoConfiguration: object

serializedName

serializedName: string = "repoConfiguration"

type

type: object

className

className: string = "FactoryRepoConfiguration"

name

name: "Composite" = "Composite"

Const FactoryUpdateParameters

FactoryUpdateParameters: object
interface

An interface representing FactoryUpdateParameters. Parameters for updating a factory resource.

Optional identity

identity: FactoryIdentity
member

{FactoryIdentity} [identity] Managed service identity of the factory.

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] The resource tags.

serializedName

serializedName: string = "FactoryUpdateParameters"

type

type: object

className

className: string = "FactoryUpdateParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

identity

identity: object

serializedName

serializedName: string = "identity"

type

type: object

className

className: string = "FactoryIdentity"

name

name: "Composite" = "Composite"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const FactoryVSTSConfiguration

FactoryVSTSConfiguration: object
interface

An interface representing FactoryVSTSConfiguration. Factory's VSTS repo information.

accountName

accountName: string
member

{string} accountName Account name.

collaborationBranch

collaborationBranch: string
member

{string} collaborationBranch Collaboration branch.

Optional lastCommitId

lastCommitId: undefined | string
member

{string} [lastCommitId] Last commit id.

projectName

projectName: string
member

{string} projectName VSTS project name.

repositoryName

repositoryName: string
member

{string} repositoryName Rrepository name.

rootFolder

rootFolder: string
member

{string} rootFolder Root folder.

Optional tenantId

tenantId: undefined | string
member

{string} [tenantId] VSTS tenant id.

serializedName

serializedName: string = "FactoryVSTSConfiguration"

type

type: object
member

{string} type Polymorphic Discriminator

className

className: string = "FactoryVSTSConfiguration"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FactoryRepoConfiguration.type.polymorphicDiscriminator

uberParent

uberParent: string = "FactoryRepoConfiguration"

modelProperties

modelProperties: object

projectName

projectName: object

required

required: true = true

serializedName

serializedName: string = "projectName"

type

type: object

name

name: "String" = "String"

tenantId

tenantId: object

serializedName

serializedName: string = "tenantId"

type

type: object

name

name: "String" = "String"

Const FileServerLinkedService

FileServerLinkedService: object
interface

An interface representing FileServerLinkedService. File system linked service.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

host

host: any
member

{any} host Host name of the server. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional password

password: SecretBaseUnion
member

{SecretBaseUnion} [password] Password to logon the server.

Optional userId

userId: any
member

{any} [userId] User ID to logon the server. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "FileServer"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "FileServerLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

host

host: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.host"

type

type: object

name

name: "Object" = "Object"

password

password: object

serializedName

serializedName: string = "typeProperties.password"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

userId

userId: object

serializedName

serializedName: string = "typeProperties.userId"

type

type: object

name

name: "Object" = "Object"

Const FileShareDataset

FileShareDataset: object
interface

An interface representing FileShareDataset. An on-premises file system dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional compression

member

{DatasetCompressionUnion} [compression] The data compression method used for the file system.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional fileFilter

fileFilter: any
member

{any} [fileFilter] Specify a filter to be used to select a subset of files in the folderPath rather than all files. Type: string (or Expression with resultType string).

Optional fileName

fileName: any
member

{any} [fileName] The name of the on-premises file system. Type: string (or Expression with resultType string).

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

Optional folderPath

folderPath: any
member

{any} [folderPath] The path of the on-premises file system. Type: string (or Expression with resultType string).

Optional format

member

{DatasetStorageFormatUnion} [format] The format of the files.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

serializedName

serializedName: string = "FileShare"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "FileShareDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

compression

compression: object

serializedName

serializedName: string = "typeProperties.compression"

type

type: object

className

className: string = "DatasetCompression"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

fileFilter

fileFilter: object

serializedName

serializedName: string = "typeProperties.fileFilter"

type

type: object

name

name: "Object" = "Object"

fileName

fileName: object

serializedName

serializedName: string = "typeProperties.fileName"

type

type: object

name

name: "Object" = "Object"

folderPath

folderPath: object

serializedName

serializedName: string = "typeProperties.folderPath"

type

type: object

name

name: "Object" = "Object"

format

format: object

serializedName

serializedName: string = "typeProperties.format"

type

type: object

className

className: string = "DatasetStorageFormat"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

Const FileSystemSink

FileSystemSink: object
interface

An interface representing FileSystemSink. A copy activity file system sink.

Optional copyBehavior

copyBehavior: CopyBehaviorType
member

{CopyBehaviorType} [copyBehavior] The type of copy behavior for copy sink. Possible values include: 'PreserveHierarchy', 'FlattenHierarchy', 'MergeFiles'

Optional sinkRetryCount

sinkRetryCount: any
member

{any} [sinkRetryCount] Sink retry count. Type: integer (or Expression with resultType integer).

Optional sinkRetryWait

sinkRetryWait: any
member

{any} [sinkRetryWait] Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Optional writeBatchSize

writeBatchSize: any
member

{any} [writeBatchSize] Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

Optional writeBatchTimeout

writeBatchTimeout: any
member

{any} [writeBatchTimeout] Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "FileSystemSink"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySink.type.additionalProperties

className

className: string = "FileSystemSink"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySink.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySink"

modelProperties

modelProperties: object

copyBehavior

copyBehavior: object

serializedName

serializedName: string = "copyBehavior"

type

type: object

name

name: "String" = "String"

Const FileSystemSource

FileSystemSource: object
interface

An interface representing FileSystemSource. A copy activity file system source.

Optional recursive

recursive: any
member

{any} [recursive] If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "FileSystemSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "FileSystemSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

recursive

recursive: object

serializedName

serializedName: string = "recursive"

type

type: object

name

name: "Object" = "Object"

Const FilterActivity

FilterActivity: object
interface

An interface representing FilterActivity. Filter and return results from input array based on the conditions.

condition

condition: Expression
member

{Expression} condition Condition to be used for filtering the input.

Optional dependsOn

dependsOn: ActivityDependency[]
member

{ActivityDependency[]} [dependsOn] Activity depends on condition.

Optional description

description: undefined | string
member

{string} [description] Activity description.

items

items: Expression
member

{Expression} items Input array on which filter should be applied.

name

name: string
member

{string} name Activity name.

Optional userProperties

userProperties: UserProperty[]
member

{UserProperty[]} [userProperties] Activity user properties.

serializedName

serializedName: string = "Filter"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Activity.type.additionalProperties

className

className: string = "FilterActivity"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Activity.type.polymorphicDiscriminator

uberParent

uberParent: string = "Activity"

modelProperties

modelProperties: object

condition

condition: object

defaultValue

defaultValue: object

Type declaration

required

required: true = true

serializedName

serializedName: string = "typeProperties.condition"

type

type: object

className

className: string = "Expression"

name

name: "Composite" = "Composite"

items

items: object

defaultValue

defaultValue: object

Type declaration

required

required: true = true

serializedName

serializedName: string = "typeProperties.items"

type

type: object

className

className: string = "Expression"

name

name: "Composite" = "Composite"

Const ForEachActivity

ForEachActivity: object
interface

An interface representing ForEachActivity. This activity is used for iterating over a collection and execute given activities.

activities

activities: ActivityUnion[]
member

{ActivityUnion[]} activities List of activities to execute .

Optional batchCount

batchCount: undefined | number
member

{number} [batchCount] Batch count to be used for controlling the number of parallel execution (when isSequential is set to false).

Optional dependsOn

dependsOn: ActivityDependency[]
member

{ActivityDependency[]} [dependsOn] Activity depends on condition.

Optional description

description: undefined | string
member

{string} [description] Activity description.

Optional isSequential

isSequential: undefined | false | true
member

{boolean} [isSequential] Should the loop be executed in sequence or in parallel (max 50)

items

items: Expression
member

{Expression} items Collection to iterate.

name

name: string
member

{string} name Activity name.

Optional userProperties

userProperties: UserProperty[]
member

{UserProperty[]} [userProperties] Activity user properties.

serializedName

serializedName: string = "ForEach"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Activity.type.additionalProperties

className

className: string = "ForEachActivity"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Activity.type.polymorphicDiscriminator

uberParent

uberParent: string = "Activity"

modelProperties

modelProperties: object

activities

activities: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.activities"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Activity"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

batchCount

batchCount: object

serializedName

serializedName: string = "typeProperties.batchCount"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 50

type

type: object

name

name: "Number" = "Number"

isSequential

isSequential: object

serializedName

serializedName: string = "typeProperties.isSequential"

type

type: object

name

name: "Boolean" = "Boolean"

items

items: object

defaultValue

defaultValue: object

Type declaration

required

required: true = true

serializedName

serializedName: string = "typeProperties.items"

type

type: object

className

className: string = "Expression"

name

name: "Composite" = "Composite"

Const FtpServerLinkedService

FtpServerLinkedService: object
interface

An interface representing FtpServerLinkedService. A FTP server Linked Service.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional authenticationType

authenticationType: FtpAuthenticationType
member

{FtpAuthenticationType} [authenticationType] The authentication type to be used to connect to the FTP server. Possible values include: 'Basic', 'Anonymous'

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional enableServerCertificateValidation

enableServerCertificateValidation: any
member

{any} [enableServerCertificateValidation] If true, validate the FTP server SSL certificate when connect over SSL/TLS channel. Default value is true. Type: boolean (or Expression with resultType boolean).

Optional enableSsl

enableSsl: any
member

{any} [enableSsl] If true, connect to the FTP server over SSL/TLS channel. Default value is true. Type: boolean (or Expression with resultType boolean).

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

host

host: any
member

{any} host Host name of the FTP server. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional password

password: SecretBaseUnion
member

{SecretBaseUnion} [password] Password to logon the FTP server.

Optional port

port: any
member

{any} [port] The TCP port number that the FTP server uses to listen for client connections. Default value is 21. Type: integer (or Expression with resultType integer), minimum: 0.

Optional userName

userName: any
member

{any} [userName] Username to logon the FTP server. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "FtpServer"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "FtpServerLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

authenticationType

authenticationType: object

serializedName

serializedName: string = "typeProperties.authenticationType"

type

type: object

name

name: "String" = "String"

enableServerCertificateValidation

enableServerCertificateValidation: object

serializedName

serializedName: string = "typeProperties.enableServerCertificateValidation"

type

type: object

name

name: "Object" = "Object"

enableSsl

enableSsl: object

serializedName

serializedName: string = "typeProperties.enableSsl"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

host

host: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.host"

type

type: object

name

name: "Object" = "Object"

password

password: object

serializedName

serializedName: string = "typeProperties.password"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

port

port: object

serializedName

serializedName: string = "typeProperties.port"

type

type: object

name

name: "Object" = "Object"

userName

userName: object

serializedName

serializedName: string = "typeProperties.userName"

type

type: object

name

name: "Object" = "Object"

Const GetMetadataActivity

GetMetadataActivity: object
interface

An interface representing GetMetadataActivity. Activity to get metadata of dataset

dataset

member

{DatasetReference} dataset GetMetadata activity dataset reference.

Optional dependsOn

dependsOn: ActivityDependency[]
member

{ActivityDependency[]} [dependsOn] Activity depends on condition.

Optional description

description: undefined | string
member

{string} [description] Activity description.

Optional fieldList

fieldList: any[]
member

{any[]} [fieldList] Fields of metadata to get from dataset.

Optional linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} [linkedServiceName] Linked service reference.

name

name: string
member

{string} name Activity name.

Optional policy

member

{ActivityPolicy} [policy] Activity policy.

Optional userProperties

userProperties: UserProperty[]
member

{UserProperty[]} [userProperties] Activity user properties.

serializedName

serializedName: string = "GetMetadata"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Activity.type.additionalProperties

className

className: string = "GetMetadataActivity"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Activity.type.polymorphicDiscriminator

uberParent

uberParent: string = "Activity"

modelProperties

modelProperties: object

dataset

dataset: object

defaultValue

defaultValue: object

Type declaration

required

required: true = true

serializedName

serializedName: string = "typeProperties.dataset"

type

type: object

className

className: string = "DatasetReference"

name

name: "Composite" = "Composite"

fieldList

fieldList: object

serializedName

serializedName: string = "typeProperties.fieldList"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "Object" = "Object"

Const GitHubAccessTokenRequest

GitHubAccessTokenRequest: object
interface

An interface representing GitHubAccessTokenRequest. Get GitHub access token request definition.

gitHubAccessCode

gitHubAccessCode: string
member

{string} gitHubAccessCode GitHub access code.

gitHubAccessTokenBaseUrl

gitHubAccessTokenBaseUrl: string
member

{string} gitHubAccessTokenBaseUrl GitHub access token base URL.

Optional gitHubClientId

gitHubClientId: undefined | string
member

{string} [gitHubClientId] GitHub application client ID.

serializedName

serializedName: string = "GitHubAccessTokenRequest"

type

type: object

className

className: string = "GitHubAccessTokenRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

gitHubAccessCode

gitHubAccessCode: object

required

required: true = true

serializedName

serializedName: string = "gitHubAccessCode"

type

type: object

name

name: "String" = "String"

gitHubAccessTokenBaseUrl

gitHubAccessTokenBaseUrl: object

required

required: true = true

serializedName

serializedName: string = "gitHubAccessTokenBaseUrl"

type

type: object

name

name: "String" = "String"

gitHubClientId

gitHubClientId: object

serializedName

serializedName: string = "gitHubClientId"

type

type: object

name

name: "String" = "String"

Const GitHubAccessTokenResponse

GitHubAccessTokenResponse: object
interface

An interface representing GitHubAccessTokenResponse. Get GitHub access token response definition.

Optional gitHubAccessToken

gitHubAccessToken: undefined | string
member

{string} [gitHubAccessToken] GitHub access token.

serializedName

serializedName: string = "GitHubAccessTokenResponse"

type

type: object

className

className: string = "GitHubAccessTokenResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

gitHubAccessToken

gitHubAccessToken: object

serializedName

serializedName: string = "gitHubAccessToken"

type

type: object

name

name: "String" = "String"

Const GoogleBigQueryLinkedService

GoogleBigQueryLinkedService: object
interface

An interface representing GoogleBigQueryLinkedService. Google BigQuery service linked service.

Optional additionalProjects

additionalProjects: any
member

{any} [additionalProjects] A comma-separated list of public BigQuery projects to access.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

authenticationType

member

{GoogleBigQueryAuthenticationType} authenticationType The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR. Possible values include: 'ServiceAuthentication', 'UserAuthentication'

Optional clientId

clientId: SecretBaseUnion
member

{SecretBaseUnion} [clientId] The client id of the google application used to acquire the refresh token.

Optional clientSecret

clientSecret: SecretBaseUnion
member

{SecretBaseUnion} [clientSecret] The client secret of the google application used to acquire the refresh token.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional email

email: any
member

{any} [email] The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional keyFilePath

keyFilePath: any
member

{any} [keyFilePath] The full path to the .p12 key file that is used to authenticate the service account email address and can only be used on self-hosted IR.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

project

project: any
member

{any} project The default BigQuery project to query against.

Optional refreshToken

refreshToken: SecretBaseUnion
member

{SecretBaseUnion} [refreshToken] The refresh token obtained from Google for authorizing access to BigQuery for UserAuthentication.

Optional requestGoogleDriveScope

requestGoogleDriveScope: any
member

{any} [requestGoogleDriveScope] Whether to request access to Google Drive. Allowing Google Drive access enables support for federated tables that combine BigQuery data with data from Google Drive. The default value is false.

Optional trustedCertPath

trustedCertPath: any
member

{any} [trustedCertPath] The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.

Optional useSystemTrustStore

useSystemTrustStore: any
member

{any} [useSystemTrustStore] Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.

serializedName

serializedName: string = "GoogleBigQuery"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "GoogleBigQueryLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

additionalProjects

additionalProjects: object

serializedName

serializedName: string = "typeProperties.additionalProjects"

type

type: object

name

name: "Object" = "Object"

authenticationType

authenticationType: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.authenticationType"

type

type: object

name

name: "String" = "String"

clientId

clientId: object

serializedName

serializedName: string = "typeProperties.clientId"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

clientSecret

clientSecret: object

serializedName

serializedName: string = "typeProperties.clientSecret"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

email

email: object

serializedName

serializedName: string = "typeProperties.email"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

keyFilePath

keyFilePath: object

serializedName

serializedName: string = "typeProperties.keyFilePath"

type

type: object

name

name: "Object" = "Object"

project

project: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.project"

type

type: object

name

name: "Object" = "Object"

refreshToken

refreshToken: object

serializedName

serializedName: string = "typeProperties.refreshToken"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

requestGoogleDriveScope

requestGoogleDriveScope: object

serializedName

serializedName: string = "typeProperties.requestGoogleDriveScope"

type

type: object

name

name: "Object" = "Object"

trustedCertPath

trustedCertPath: object

serializedName

serializedName: string = "typeProperties.trustedCertPath"

type

type: object

name

name: "Object" = "Object"

useSystemTrustStore

useSystemTrustStore: object

serializedName

serializedName: string = "typeProperties.useSystemTrustStore"

type

type: object

name

name: "Object" = "Object"

Const GoogleBigQueryObjectDataset

GoogleBigQueryObjectDataset: object
interface

An interface representing GoogleBigQueryObjectDataset. Google BigQuery service dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Optional tableName

tableName: any
member

{any} [tableName] The table name. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "GoogleBigQueryObject"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "GoogleBigQueryObjectDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

tableName

tableName: object

serializedName

serializedName: string = "typeProperties.tableName"

type

type: object

name

name: "Object" = "Object"

Const GoogleBigQuerySource

GoogleBigQuerySource: object
interface

An interface representing GoogleBigQuerySource. A copy activity Google BigQuery service source.

Optional query

query: any
member

{any} [query] A query to retrieve data from source. Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "GoogleBigQuerySource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "GoogleBigQuerySource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

Const GreenplumLinkedService

GreenplumLinkedService: object
interface

An interface representing GreenplumLinkedService. Greenplum Database linked service.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional connectionString

connectionString: any
member

{any} [connectionString] An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional pwd

member

{AzureKeyVaultSecretReference} [pwd] The Azure key vault secret reference of password in connection string.

serializedName

serializedName: string = "Greenplum"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "GreenplumLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

connectionString

connectionString: object

serializedName

serializedName: string = "typeProperties.connectionString"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

pwd

pwd: object

serializedName

serializedName: string = "typeProperties.pwd"

type

type: object

className

className: string = "AzureKeyVaultSecretReference"

name

name: "Composite" = "Composite"

Const GreenplumSource

GreenplumSource: object
interface

An interface representing GreenplumSource. A copy activity Greenplum Database source.

Optional query

query: any
member

{any} [query] A query to retrieve data from source. Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "GreenplumSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "GreenplumSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

Const GreenplumTableDataset

GreenplumTableDataset: object
interface

An interface representing GreenplumTableDataset. Greenplum Database dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Optional tableName

tableName: any
member

{any} [tableName] The table name. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "GreenplumTable"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "GreenplumTableDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

tableName

tableName: object

serializedName

serializedName: string = "typeProperties.tableName"

type

type: object

name

name: "Object" = "Object"

Const HBaseLinkedService

HBaseLinkedService: object
interface

An interface representing HBaseLinkedService. HBase server linked service.

Optional allowHostNameCNMismatch

allowHostNameCNMismatch: any
member

{any} [allowHostNameCNMismatch] Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.

Optional allowSelfSignedServerCert

allowSelfSignedServerCert: any
member

{any} [allowSelfSignedServerCert] Specifies whether to allow self-signed certificates from the server. The default value is false.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

authenticationType

authenticationType: HBaseAuthenticationType
member

{HBaseAuthenticationType} authenticationType The authentication mechanism to use to connect to the HBase server. Possible values include: 'Anonymous', 'Basic'

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional enableSsl

enableSsl: any
member

{any} [enableSsl] Specifies whether the connections to the server are encrypted using SSL. The default value is false.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

host

host: any
member

{any} host The IP address or host name of the HBase server. (i.e. 192.168.222.160)

Optional httpPath

httpPath: any
member

{any} [httpPath] The partial URL corresponding to the HBase server. (i.e. /gateway/sandbox/hbase/version)

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional password

password: SecretBaseUnion
member

{SecretBaseUnion} [password] The password corresponding to the user name.

Optional port

port: any
member

{any} [port] The TCP port that the HBase instance uses to listen for client connections. The default value is 9090.

Optional trustedCertPath

trustedCertPath: any
member

{any} [trustedCertPath] The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.

Optional username

username: any
member

{any} [username] The user name used to connect to the HBase instance.

serializedName

serializedName: string = "HBase"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "HBaseLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

allowHostNameCNMismatch

allowHostNameCNMismatch: object

serializedName

serializedName: string = "typeProperties.allowHostNameCNMismatch"

type

type: object

name

name: "Object" = "Object"

allowSelfSignedServerCert

allowSelfSignedServerCert: object

serializedName

serializedName: string = "typeProperties.allowSelfSignedServerCert"

type

type: object

name

name: "Object" = "Object"

authenticationType

authenticationType: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.authenticationType"

type

type: object

name

name: "String" = "String"

enableSsl

enableSsl: object

serializedName

serializedName: string = "typeProperties.enableSsl"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

host

host: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.host"

type

type: object

name

name: "Object" = "Object"

httpPath

httpPath: object

serializedName

serializedName: string = "typeProperties.httpPath"

type

type: object

name

name: "Object" = "Object"

password

password: object

serializedName

serializedName: string = "typeProperties.password"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

port

port: object

serializedName

serializedName: string = "typeProperties.port"

type

type: object

name

name: "Object" = "Object"

trustedCertPath

trustedCertPath: object

serializedName

serializedName: string = "typeProperties.trustedCertPath"

type

type: object

name

name: "Object" = "Object"

username

username: object

serializedName

serializedName: string = "typeProperties.username"

type

type: object

name

name: "Object" = "Object"

Const HBaseObjectDataset

HBaseObjectDataset: object
interface

An interface representing HBaseObjectDataset. HBase server dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Optional tableName

tableName: any
member

{any} [tableName] The table name. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "HBaseObject"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "HBaseObjectDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

tableName

tableName: object

serializedName

serializedName: string = "typeProperties.tableName"

type

type: object

name

name: "Object" = "Object"

Const HBaseSource

HBaseSource: object
interface

An interface representing HBaseSource. A copy activity HBase server source.

Optional query

query: any
member

{any} [query] A query to retrieve data from source. Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "HBaseSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "HBaseSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

Const HDInsightHiveActivity

HDInsightHiveActivity: object
interface

An interface representing HDInsightHiveActivity. HDInsight Hive activity type.

Optional argumentsProperty

argumentsProperty: any[]
member

{any[]} [argumentsProperty] User specified arguments to HDInsightActivity.

Optional defines

defines: undefined | object
member

{{ [propertyName: string]: any }} [defines] Allows user to specify defines for Hive job request.

Optional dependsOn

dependsOn: ActivityDependency[]
member

{ActivityDependency[]} [dependsOn] Activity depends on condition.

Optional description

description: undefined | string
member

{string} [description] Activity description.

Optional getDebugInfo

member

{HDInsightActivityDebugInfoOption} [getDebugInfo] Debug info option. Possible values include: 'None', 'Always', 'Failure'

Optional linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} [linkedServiceName] Linked service reference.

name

name: string
member

{string} name Activity name.

Optional policy

member

{ActivityPolicy} [policy] Activity policy.

Optional scriptLinkedService

scriptLinkedService: LinkedServiceReference
member

{LinkedServiceReference} [scriptLinkedService] Script linked service reference.

Optional scriptPath

scriptPath: any
member

{any} [scriptPath] Script path. Type: string (or Expression with resultType string).

Optional storageLinkedServices

storageLinkedServices: LinkedServiceReference[]
member

{LinkedServiceReference[]} [storageLinkedServices] Storage linked service references.

Optional userProperties

userProperties: UserProperty[]
member

{UserProperty[]} [userProperties] Activity user properties.

serializedName

serializedName: string = "HDInsightHive"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Activity.type.additionalProperties

className

className: string = "HDInsightHiveActivity"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Activity.type.polymorphicDiscriminator

uberParent

uberParent: string = "Activity"

modelProperties

modelProperties: object

argumentsProperty

argumentsProperty: object

serializedName

serializedName: string = "typeProperties.arguments"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "Object" = "Object"

defines

defines: object

serializedName

serializedName: string = "typeProperties.defines"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Object" = "Object"

getDebugInfo

getDebugInfo: object

serializedName

serializedName: string = "typeProperties.getDebugInfo"

type

type: object

name

name: "String" = "String"

scriptLinkedService

scriptLinkedService: object

serializedName

serializedName: string = "typeProperties.scriptLinkedService"

type

type: object

className

className: string = "LinkedServiceReference"

name

name: "Composite" = "Composite"

scriptPath

scriptPath: object

serializedName

serializedName: string = "typeProperties.scriptPath"

type

type: object

name

name: "Object" = "Object"

storageLinkedServices

storageLinkedServices: object

serializedName

serializedName: string = "typeProperties.storageLinkedServices"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LinkedServiceReference"

name

name: "Composite" = "Composite"

Const HDInsightLinkedService

HDInsightLinkedService: object
interface

An interface representing HDInsightLinkedService. HDInsight linked service.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

clusterUri

clusterUri: any
member

{any} clusterUri HDInsight cluster URI. Type: string (or Expression with resultType string).

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional hcatalogLinkedServiceName

hcatalogLinkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} [hcatalogLinkedServiceName] A reference to the Azure SQL linked service that points to the HCatalog database.

Optional linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} [linkedServiceName] The Azure Storage linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional password

password: SecretBaseUnion
member

{SecretBaseUnion} [password] HDInsight cluster password.

Optional userName

userName: any
member

{any} [userName] HDInsight cluster user name. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "HDInsight"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "HDInsightLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

clusterUri

clusterUri: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.clusterUri"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

hcatalogLinkedServiceName

hcatalogLinkedServiceName: object

serializedName

serializedName: string = "typeProperties.hcatalogLinkedServiceName"

type

type: object

className

className: string = "LinkedServiceReference"

name

name: "Composite" = "Composite"

linkedServiceName

linkedServiceName: object

serializedName

serializedName: string = "typeProperties.linkedServiceName"

type

type: object

className

className: string = "LinkedServiceReference"

name

name: "Composite" = "Composite"

password

password: object

serializedName

serializedName: string = "typeProperties.password"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

userName

userName: object

serializedName

serializedName: string = "typeProperties.userName"

type

type: object

name

name: "Object" = "Object"

Const HDInsightMapReduceActivity

HDInsightMapReduceActivity: object
interface

An interface representing HDInsightMapReduceActivity. HDInsight MapReduce activity type.

Optional argumentsProperty

argumentsProperty: any[]
member

{any[]} [argumentsProperty] User specified arguments to HDInsightActivity.

className

className: any
member

{any} className Class name. Type: string (or Expression with resultType string).

Optional defines

defines: undefined | object
member

{{ [propertyName: string]: any }} [defines] Allows user to specify defines for the MapReduce job request.

Optional dependsOn

dependsOn: ActivityDependency[]
member

{ActivityDependency[]} [dependsOn] Activity depends on condition.

Optional description

description: undefined | string
member

{string} [description] Activity description.

Optional getDebugInfo

member

{HDInsightActivityDebugInfoOption} [getDebugInfo] Debug info option. Possible values include: 'None', 'Always', 'Failure'

jarFilePath

jarFilePath: any
member

{any} jarFilePath Jar path. Type: string (or Expression with resultType string).

Optional jarLibs

jarLibs: any[]
member

{any[]} [jarLibs] Jar libs.

Optional jarLinkedService

jarLinkedService: LinkedServiceReference
member

{LinkedServiceReference} [jarLinkedService] Jar linked service reference.

Optional linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} [linkedServiceName] Linked service reference.

name

name: string
member

{string} name Activity name.

Optional policy

member

{ActivityPolicy} [policy] Activity policy.

Optional storageLinkedServices

storageLinkedServices: LinkedServiceReference[]
member

{LinkedServiceReference[]} [storageLinkedServices] Storage linked service references.

Optional userProperties

userProperties: UserProperty[]
member

{UserProperty[]} [userProperties] Activity user properties.

serializedName

serializedName: string = "HDInsightMapReduce"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Activity.type.additionalProperties

className

className: string = "HDInsightMapReduceActivity"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Activity.type.polymorphicDiscriminator

uberParent

uberParent: string = "Activity"

modelProperties

modelProperties: object

argumentsProperty

argumentsProperty: object

serializedName

serializedName: string = "typeProperties.arguments"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "Object" = "Object"

className

className: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.className"

type

type: object

name

name: "Object" = "Object"

defines

defines: object

serializedName

serializedName: string = "typeProperties.defines"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Object" = "Object"

getDebugInfo

getDebugInfo: object

serializedName

serializedName: string = "typeProperties.getDebugInfo"

type

type: object

name

name: "String" = "String"

jarFilePath

jarFilePath: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.jarFilePath"

type

type: object

name

name: "Object" = "Object"

jarLibs

jarLibs: object

serializedName

serializedName: string = "typeProperties.jarLibs"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "Object" = "Object"

jarLinkedService

jarLinkedService: object

serializedName

serializedName: string = "typeProperties.jarLinkedService"

type

type: object

className

className: string = "LinkedServiceReference"

name

name: "Composite" = "Composite"

storageLinkedServices

storageLinkedServices: object

serializedName

serializedName: string = "typeProperties.storageLinkedServices"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LinkedServiceReference"

name

name: "Composite" = "Composite"

Const HDInsightOnDemandLinkedService

HDInsightOnDemandLinkedService: object
interface

An interface representing HDInsightOnDemandLinkedService. HDInsight ondemand linked service.

Optional additionalLinkedServiceNames

additionalLinkedServiceNames: LinkedServiceReference[]
member

{LinkedServiceReference[]} [additionalLinkedServiceNames] Specifies additional storage accounts for the HDInsight linked service so that the Data Factory service can register them on your behalf.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional clusterNamePrefix

clusterNamePrefix: any
member

{any} [clusterNamePrefix] The prefix of cluster name, postfix will be distinct with timestamp. Type: string (or Expression with resultType string).

Optional clusterPassword

clusterPassword: SecretBaseUnion
member

{SecretBaseUnion} [clusterPassword] The password to access the cluster.

clusterResourceGroup

clusterResourceGroup: any
member

{any} clusterResourceGroup The resource group where the cluster belongs. Type: string (or Expression with resultType string).

clusterSize

clusterSize: any
member

{any} clusterSize Number of worker/data nodes in the cluster. Suggestion value: 4. Type: string (or Expression with resultType string).

Optional clusterSshPassword

clusterSshPassword: SecretBaseUnion
member

{SecretBaseUnion} [clusterSshPassword] The password to SSH remotely connect cluster’s node (for Linux).

Optional clusterSshUserName

clusterSshUserName: any
member

{any} [clusterSshUserName] The username to SSH remotely connect to cluster’s node (for Linux). Type: string (or Expression with resultType string).

Optional clusterType

clusterType: any
member

{any} [clusterType] The cluster type. Type: string (or Expression with resultType string).

Optional clusterUserName

clusterUserName: any
member

{any} [clusterUserName] The username to access the cluster. Type: string (or Expression with resultType string).

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional coreConfiguration

coreConfiguration: any
member

{any} [coreConfiguration] Specifies the core configuration parameters (as in core-site.xml) for the HDInsight cluster to be created.

Optional dataNodeSize

dataNodeSize: any
member

{any} [dataNodeSize] Specifies the size of the data node for the HDInsight cluster.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional hBaseConfiguration

hBaseConfiguration: any
member

{any} [hBaseConfiguration] Specifies the HBase configuration parameters (hbase-site.xml) for the HDInsight cluster.

Optional hcatalogLinkedServiceName

hcatalogLinkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} [hcatalogLinkedServiceName] The name of Azure SQL linked service that point to the HCatalog database. The on-demand HDInsight cluster is created by using the Azure SQL database as the metastore.

Optional hdfsConfiguration

hdfsConfiguration: any
member

{any} [hdfsConfiguration] Specifies the HDFS configuration parameters (hdfs-site.xml) for the HDInsight cluster.

Optional headNodeSize

headNodeSize: any
member

{any} [headNodeSize] Specifies the size of the head node for the HDInsight cluster.

Optional hiveConfiguration

hiveConfiguration: any
member

{any} [hiveConfiguration] Specifies the hive configuration parameters (hive-site.xml) for the HDInsight cluster.

hostSubscriptionId

hostSubscriptionId: any
member

{any} hostSubscriptionId The customer’s subscription to host the cluster. Type: string (or Expression with resultType string).

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Azure Storage linked service to be used by the on-demand cluster for storing and processing data.

Optional mapReduceConfiguration

mapReduceConfiguration: any
member

{any} [mapReduceConfiguration] Specifies the MapReduce configuration parameters (mapred-site.xml) for the HDInsight cluster.

Optional oozieConfiguration

oozieConfiguration: any
member

{any} [oozieConfiguration] Specifies the Oozie configuration parameters (oozie-site.xml) for the HDInsight cluster.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional scriptActions

scriptActions: ScriptAction[]

Optional servicePrincipalId

servicePrincipalId: any
member

{any} [servicePrincipalId] The service principal id for the hostSubscriptionId. Type: string (or Expression with resultType string).

Optional servicePrincipalKey

servicePrincipalKey: SecretBaseUnion
member

{SecretBaseUnion} [servicePrincipalKey] The key for the service principal id.

Optional sparkVersion

sparkVersion: any
member

{any} [sparkVersion] The version of spark if the cluster type is 'spark'. Type: string (or Expression with resultType string).

Optional stormConfiguration

stormConfiguration: any
member

{any} [stormConfiguration] Specifies the Storm configuration parameters (storm-site.xml) for the HDInsight cluster.

tenant

tenant: any
member

{any} tenant The Tenant id/name to which the service principal belongs. Type: string (or Expression with resultType string).

timeToLive

timeToLive: any
member

{any} timeToLive The allowed idle time for the on-demand HDInsight cluster. Specifies how long the on-demand HDInsight cluster stays alive after completion of an activity run if there are no other active jobs in the cluster. The minimum value is 5 mins. Type: string (or Expression with resultType string).

version

version: any
member

{any} version Version of the HDInsight cluster. Type: string (or Expression with resultType string).

Optional yarnConfiguration

yarnConfiguration: any
member

{any} [yarnConfiguration] Specifies the Yarn configuration parameters (yarn-site.xml) for the HDInsight cluster.

Optional zookeeperNodeSize

zookeeperNodeSize: any
member

{any} [zookeeperNodeSize] Specifies the size of the Zoo Keeper node for the HDInsight cluster.

serializedName

serializedName: string = "HDInsightOnDemand"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "HDInsightOnDemandLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

additionalLinkedServiceNames

additionalLinkedServiceNames: object

serializedName

serializedName: string = "typeProperties.additionalLinkedServiceNames"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LinkedServiceReference"

name

name: "Composite" = "Composite"

clusterNamePrefix

clusterNamePrefix: object

serializedName

serializedName: string = "typeProperties.clusterNamePrefix"

type

type: object

name

name: "Object" = "Object"

clusterPassword

clusterPassword: object

serializedName

serializedName: string = "typeProperties.clusterPassword"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

clusterResourceGroup

clusterResourceGroup: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.clusterResourceGroup"

type

type: object

name

name: "Object" = "Object"

clusterSize

clusterSize: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.clusterSize"

type

type: object

name

name: "Object" = "Object"

clusterSshPassword

clusterSshPassword: object

serializedName

serializedName: string = "typeProperties.clusterSshPassword"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

clusterSshUserName

clusterSshUserName: object

serializedName

serializedName: string = "typeProperties.clusterSshUserName"

type

type: object

name

name: "Object" = "Object"

clusterType

clusterType: object

serializedName

serializedName: string = "typeProperties.clusterType"

type

type: object

name

name: "Object" = "Object"

clusterUserName

clusterUserName: object

serializedName

serializedName: string = "typeProperties.clusterUserName"

type

type: object

name

name: "Object" = "Object"

coreConfiguration

coreConfiguration: object

serializedName

serializedName: string = "typeProperties.coreConfiguration"

type

type: object

name

name: "Object" = "Object"

dataNodeSize

dataNodeSize: object

serializedName

serializedName: string = "typeProperties.dataNodeSize"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

hBaseConfiguration

hBaseConfiguration: object

serializedName

serializedName: string = "typeProperties.hBaseConfiguration"

type

type: object

name

name: "Object" = "Object"

hcatalogLinkedServiceName

hcatalogLinkedServiceName: object

serializedName

serializedName: string = "typeProperties.hcatalogLinkedServiceName"

type

type: object

className

className: string = "LinkedServiceReference"

name

name: "Composite" = "Composite"

hdfsConfiguration

hdfsConfiguration: object

serializedName

serializedName: string = "typeProperties.hdfsConfiguration"

type

type: object

name

name: "Object" = "Object"

headNodeSize

headNodeSize: object

serializedName

serializedName: string = "typeProperties.headNodeSize"

type

type: object

name

name: "Object" = "Object"

hiveConfiguration

hiveConfiguration: object

serializedName

serializedName: string = "typeProperties.hiveConfiguration"

type

type: object

name

name: "Object" = "Object"

hostSubscriptionId

hostSubscriptionId: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.hostSubscriptionId"

type

type: object

name

name: "Object" = "Object"

linkedServiceName

linkedServiceName: object

defaultValue

defaultValue: object

Type declaration

required

required: true = true

serializedName

serializedName: string = "typeProperties.linkedServiceName"

type

type: object

className

className: string = "LinkedServiceReference"

name

name: "Composite" = "Composite"

mapReduceConfiguration

mapReduceConfiguration: object

serializedName

serializedName: string = "typeProperties.mapReduceConfiguration"

type

type: object

name

name: "Object" = "Object"

oozieConfiguration

oozieConfiguration: object

serializedName

serializedName: string = "typeProperties.oozieConfiguration"

type

type: object

name

name: "Object" = "Object"

scriptActions

scriptActions: object

serializedName

serializedName: string = "typeProperties.scriptActions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ScriptAction"

name

name: "Composite" = "Composite"

servicePrincipalId

servicePrincipalId: object

serializedName

serializedName: string = "typeProperties.servicePrincipalId"

type

type: object

name

name: "Object" = "Object"

servicePrincipalKey

servicePrincipalKey: object

serializedName

serializedName: string = "typeProperties.servicePrincipalKey"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

sparkVersion

sparkVersion: object

serializedName

serializedName: string = "typeProperties.sparkVersion"

type

type: object

name

name: "Object" = "Object"

stormConfiguration

stormConfiguration: object

serializedName

serializedName: string = "typeProperties.stormConfiguration"

type

type: object

name

name: "Object" = "Object"

tenant

tenant: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.tenant"

type

type: object

name

name: "Object" = "Object"

timeToLive

timeToLive: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.timeToLive"

type

type: object

name

name: "Object" = "Object"

version

version: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.version"

type

type: object

name

name: "Object" = "Object"

yarnConfiguration

yarnConfiguration: object

serializedName

serializedName: string = "typeProperties.yarnConfiguration"

type

type: object

name

name: "Object" = "Object"

zookeeperNodeSize

zookeeperNodeSize: object

serializedName

serializedName: string = "typeProperties.zookeeperNodeSize"

type

type: object

name

name: "Object" = "Object"

Const HDInsightPigActivity

HDInsightPigActivity: object
interface

An interface representing HDInsightPigActivity. HDInsight Pig activity type.

Optional argumentsProperty

argumentsProperty: any[]
member

{any[]} [argumentsProperty] User specified arguments to HDInsightActivity.

Optional defines

defines: undefined | object
member

{{ [propertyName: string]: any }} [defines] Allows user to specify defines for Pig job request.

Optional dependsOn

dependsOn: ActivityDependency[]
member

{ActivityDependency[]} [dependsOn] Activity depends on condition.

Optional description

description: undefined | string
member

{string} [description] Activity description.

Optional getDebugInfo

member

{HDInsightActivityDebugInfoOption} [getDebugInfo] Debug info option. Possible values include: 'None', 'Always', 'Failure'

Optional linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} [linkedServiceName] Linked service reference.

name

name: string
member

{string} name Activity name.

Optional policy

member

{ActivityPolicy} [policy] Activity policy.

Optional scriptLinkedService

scriptLinkedService: LinkedServiceReference
member

{LinkedServiceReference} [scriptLinkedService] Script linked service reference.

Optional scriptPath

scriptPath: any
member

{any} [scriptPath] Script path. Type: string (or Expression with resultType string).

Optional storageLinkedServices

storageLinkedServices: LinkedServiceReference[]
member

{LinkedServiceReference[]} [storageLinkedServices] Storage linked service references.

Optional userProperties

userProperties: UserProperty[]
member

{UserProperty[]} [userProperties] Activity user properties.

serializedName

serializedName: string = "HDInsightPig"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Activity.type.additionalProperties

className

className: string = "HDInsightPigActivity"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Activity.type.polymorphicDiscriminator

uberParent

uberParent: string = "Activity"

modelProperties

modelProperties: object

argumentsProperty

argumentsProperty: object

serializedName

serializedName: string = "typeProperties.arguments"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "Object" = "Object"

defines

defines: object

serializedName

serializedName: string = "typeProperties.defines"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Object" = "Object"

getDebugInfo

getDebugInfo: object

serializedName

serializedName: string = "typeProperties.getDebugInfo"

type

type: object

name

name: "String" = "String"

scriptLinkedService

scriptLinkedService: object

serializedName

serializedName: string = "typeProperties.scriptLinkedService"

type

type: object

className

className: string = "LinkedServiceReference"

name

name: "Composite" = "Composite"

scriptPath

scriptPath: object

serializedName

serializedName: string = "typeProperties.scriptPath"

type

type: object

name

name: "Object" = "Object"

storageLinkedServices

storageLinkedServices: object

serializedName

serializedName: string = "typeProperties.storageLinkedServices"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LinkedServiceReference"

name

name: "Composite" = "Composite"

Const HDInsightSparkActivity

HDInsightSparkActivity: object
interface

An interface representing HDInsightSparkActivity. HDInsight Spark activity.

Optional argumentsProperty

argumentsProperty: any[]
member

{any[]} [argumentsProperty] The user-specified arguments to HDInsightSparkActivity.

Optional className

className: undefined | string
member

{string} [className] The application's Java/Spark main class.

Optional dependsOn

dependsOn: ActivityDependency[]
member

{ActivityDependency[]} [dependsOn] Activity depends on condition.

Optional description

description: undefined | string
member

{string} [description] Activity description.

entryFilePath

entryFilePath: any
member

{any} entryFilePath The relative path to the root folder of the code/package to be executed. Type: string (or Expression with resultType string).

Optional getDebugInfo

member

{HDInsightActivityDebugInfoOption} [getDebugInfo] Debug info option. Possible values include: 'None', 'Always', 'Failure'

Optional linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} [linkedServiceName] Linked service reference.

name

name: string
member

{string} name Activity name.

Optional policy

member

{ActivityPolicy} [policy] Activity policy.

Optional proxyUser

proxyUser: any
member

{any} [proxyUser] The user to impersonate that will execute the job. Type: string (or Expression with resultType string).

rootPath

rootPath: any
member

{any} rootPath The root path in 'sparkJobLinkedService' for all the job’s files. Type: string (or Expression with resultType string).

Optional sparkConfig

sparkConfig: undefined | object
member

{{ [propertyName: string]: any }} [sparkConfig] Spark configuration property.

Optional sparkJobLinkedService

sparkJobLinkedService: LinkedServiceReference
member

{LinkedServiceReference} [sparkJobLinkedService] The storage linked service for uploading the entry file and dependencies, and for receiving logs.

Optional userProperties

userProperties: UserProperty[]
member

{UserProperty[]} [userProperties] Activity user properties.

serializedName

serializedName: string = "HDInsightSpark"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Activity.type.additionalProperties

className

className: string = "HDInsightSparkActivity"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Activity.type.polymorphicDiscriminator

uberParent

uberParent: string = "Activity"

modelProperties

modelProperties: object

argumentsProperty

argumentsProperty: object

serializedName

serializedName: string = "typeProperties.arguments"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "Object" = "Object"

className

className: object

serializedName

serializedName: string = "typeProperties.className"

type

type: object

name

name: "String" = "String"

entryFilePath

entryFilePath: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.entryFilePath"

type

type: object

name

name: "Object" = "Object"

getDebugInfo

getDebugInfo: object

serializedName

serializedName: string = "typeProperties.getDebugInfo"

type

type: object

name

name: "String" = "String"

proxyUser

proxyUser: object

serializedName

serializedName: string = "typeProperties.proxyUser"

type

type: object

name

name: "Object" = "Object"

rootPath

rootPath: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.rootPath"

type

type: object

name

name: "Object" = "Object"

sparkConfig

sparkConfig: object

serializedName

serializedName: string = "typeProperties.sparkConfig"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Object" = "Object"

sparkJobLinkedService

sparkJobLinkedService: object

serializedName

serializedName: string = "typeProperties.sparkJobLinkedService"

type

type: object

className

className: string = "LinkedServiceReference"

name

name: "Composite" = "Composite"

Const HDInsightStreamingActivity

HDInsightStreamingActivity: object
interface

An interface representing HDInsightStreamingActivity. HDInsight streaming activity type.

Optional argumentsProperty

argumentsProperty: any[]
member

{any[]} [argumentsProperty] User specified arguments to HDInsightActivity.

Optional combiner

combiner: any
member

{any} [combiner] Combiner executable name. Type: string (or Expression with resultType string).

Optional commandEnvironment

commandEnvironment: any[]
member

{any[]} [commandEnvironment] Command line environment values.

Optional defines

defines: undefined | object
member

{{ [propertyName: string]: any }} [defines] Allows user to specify defines for streaming job request.

Optional dependsOn

dependsOn: ActivityDependency[]
member

{ActivityDependency[]} [dependsOn] Activity depends on condition.

Optional description

description: undefined | string
member

{string} [description] Activity description.

Optional fileLinkedService

fileLinkedService: LinkedServiceReference
member

{LinkedServiceReference} [fileLinkedService] Linked service reference where the files are located.

filePaths

filePaths: any[]
member

{any[]} filePaths Paths to streaming job files. Can be directories.

Optional getDebugInfo

member

{HDInsightActivityDebugInfoOption} [getDebugInfo] Debug info option. Possible values include: 'None', 'Always', 'Failure'

input

input: any
member

{any} input Input blob path. Type: string (or Expression with resultType string).

Optional linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} [linkedServiceName] Linked service reference.

mapper

mapper: any
member

{any} mapper Mapper executable name. Type: string (or Expression with resultType string).

name

name: string
member

{string} name Activity name.

output

output: any
member

{any} output Output blob path. Type: string (or Expression with resultType string).

Optional policy

member

{ActivityPolicy} [policy] Activity policy.

reducer

reducer: any
member

{any} reducer Reducer executable name. Type: string (or Expression with resultType string).

Optional storageLinkedServices

storageLinkedServices: LinkedServiceReference[]
member

{LinkedServiceReference[]} [storageLinkedServices] Storage linked service references.

Optional userProperties

userProperties: UserProperty[]
member

{UserProperty[]} [userProperties] Activity user properties.

serializedName

serializedName: string = "HDInsightStreaming"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Activity.type.additionalProperties

className

className: string = "HDInsightStreamingActivity"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Activity.type.polymorphicDiscriminator

uberParent

uberParent: string = "Activity"

modelProperties

modelProperties: object

argumentsProperty

argumentsProperty: object

serializedName

serializedName: string = "typeProperties.arguments"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "Object" = "Object"

combiner

combiner: object

serializedName

serializedName: string = "typeProperties.combiner"

type

type: object

name

name: "Object" = "Object"

commandEnvironment

commandEnvironment: object

serializedName

serializedName: string = "typeProperties.commandEnvironment"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "Object" = "Object"

defines

defines: object

serializedName

serializedName: string = "typeProperties.defines"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Object" = "Object"

fileLinkedService

fileLinkedService: object

serializedName

serializedName: string = "typeProperties.fileLinkedService"

type

type: object

className

className: string = "LinkedServiceReference"

name

name: "Composite" = "Composite"

filePaths

filePaths: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.filePaths"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "Object" = "Object"

getDebugInfo

getDebugInfo: object

serializedName

serializedName: string = "typeProperties.getDebugInfo"

type

type: object

name

name: "String" = "String"

input

input: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.input"

type

type: object

name

name: "Object" = "Object"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.mapper"

type

type: object

name

name: "Object" = "Object"

output

output: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.output"

type

type: object

name

name: "Object" = "Object"

reducer

reducer: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.reducer"

type

type: object

name

name: "Object" = "Object"

storageLinkedServices

storageLinkedServices: object

serializedName

serializedName: string = "typeProperties.storageLinkedServices"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LinkedServiceReference"

name

name: "Composite" = "Composite"

Const HdfsLinkedService

HdfsLinkedService: object
interface

An interface representing HdfsLinkedService. Hadoop Distributed File System (HDFS) linked service.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional authenticationType

authenticationType: any
member

{any} [authenticationType] Type of authentication used to connect to the HDFS. Possible values are: Anonymous and Windows. Type: string (or Expression with resultType string).

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional password

password: SecretBaseUnion
member

{SecretBaseUnion} [password] Password for Windows authentication.

url

url: any
member

{any} url The URL of the HDFS service endpoint, e.g. http://myhostname:50070/webhdfs/v1 . Type: string (or Expression with resultType string).

Optional userName

userName: any
member

{any} [userName] User name for Windows authentication. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "Hdfs"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "HdfsLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

authenticationType

authenticationType: object

serializedName

serializedName: string = "typeProperties.authenticationType"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

password

password: object

serializedName

serializedName: string = "typeProperties.password"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

url

url: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.url"

type

type: object

name

name: "Object" = "Object"

userName

userName: object

serializedName

serializedName: string = "typeProperties.userName"

type

type: object

name

name: "Object" = "Object"

Const HdfsSource

HdfsSource: object
interface

An interface representing HdfsSource. A copy activity HDFS source.

Optional distcpSettings

distcpSettings: DistcpSettings
member

{DistcpSettings} [distcpSettings] Specifies Distcp-related settings.

Optional recursive

recursive: any
member

{any} [recursive] If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "HdfsSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "HdfsSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

distcpSettings

distcpSettings: object

serializedName

serializedName: string = "distcpSettings"

type

type: object

className

className: string = "DistcpSettings"

name

name: "Composite" = "Composite"

recursive

recursive: object

serializedName

serializedName: string = "recursive"

type

type: object

name

name: "Object" = "Object"

Const HiveLinkedService

HiveLinkedService: object
interface

An interface representing HiveLinkedService. Hive Server linked service.

Optional allowHostNameCNMismatch

allowHostNameCNMismatch: any
member

{any} [allowHostNameCNMismatch] Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.

Optional allowSelfSignedServerCert

allowSelfSignedServerCert: any
member

{any} [allowSelfSignedServerCert] Specifies whether to allow self-signed certificates from the server. The default value is false.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

authenticationType

authenticationType: HiveAuthenticationType
member

{HiveAuthenticationType} authenticationType The authentication method used to access the Hive server. Possible values include: 'Anonymous', 'Username', 'UsernameAndPassword', 'WindowsAzureHDInsightService'

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional enableSsl

enableSsl: any
member

{any} [enableSsl] Specifies whether the connections to the server are encrypted using SSL. The default value is false.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

host

host: any
member

{any} host IP address or host name of the Hive server, separated by ';' for multiple hosts (only when serviceDiscoveryMode is enable).

Optional httpPath

httpPath: any
member

{any} [httpPath] The partial URL corresponding to the Hive server.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional password

password: SecretBaseUnion
member

{SecretBaseUnion} [password] The password corresponding to the user name that you provided in the Username field

Optional port

port: any
member

{any} [port] The TCP port that the Hive server uses to listen for client connections.

Optional serverType

serverType: HiveServerType
member

{HiveServerType} [serverType] The type of Hive server. Possible values include: 'HiveServer1', 'HiveServer2', 'HiveThriftServer'

Optional serviceDiscoveryMode

serviceDiscoveryMode: any
member

{any} [serviceDiscoveryMode] true to indicate using the ZooKeeper service, false not.

Optional thriftTransportProtocol

thriftTransportProtocol: HiveThriftTransportProtocol
member

{HiveThriftTransportProtocol} [thriftTransportProtocol] The transport protocol to use in the Thrift layer. Possible values include: 'Binary', 'SASL', 'HTTP '

Optional trustedCertPath

trustedCertPath: any
member

{any} [trustedCertPath] The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.

Optional useNativeQuery

useNativeQuery: any
member

{any} [useNativeQuery] Specifies whether the driver uses native HiveQL queries,or converts them into an equivalent form in HiveQL.

Optional useSystemTrustStore

useSystemTrustStore: any
member

{any} [useSystemTrustStore] Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.

Optional username

username: any
member

{any} [username] The user name that you use to access Hive Server.

Optional zooKeeperNameSpace

zooKeeperNameSpace: any
member

{any} [zooKeeperNameSpace] The namespace on ZooKeeper under which Hive Server 2 nodes are added.

serializedName

serializedName: string = "Hive"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "HiveLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

allowHostNameCNMismatch

allowHostNameCNMismatch: object

serializedName

serializedName: string = "typeProperties.allowHostNameCNMismatch"

type

type: object

name

name: "Object" = "Object"

allowSelfSignedServerCert

allowSelfSignedServerCert: object

serializedName

serializedName: string = "typeProperties.allowSelfSignedServerCert"

type

type: object

name

name: "Object" = "Object"

authenticationType

authenticationType: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.authenticationType"

type

type: object

name

name: "String" = "String"

enableSsl

enableSsl: object

serializedName

serializedName: string = "typeProperties.enableSsl"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

host

host: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.host"

type

type: object

name

name: "Object" = "Object"

httpPath

httpPath: object

serializedName

serializedName: string = "typeProperties.httpPath"

type

type: object

name

name: "Object" = "Object"

password

password: object

serializedName

serializedName: string = "typeProperties.password"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

port

port: object

serializedName

serializedName: string = "typeProperties.port"

type

type: object

name

name: "Object" = "Object"

serverType

serverType: object

serializedName

serializedName: string = "typeProperties.serverType"

type

type: object

name

name: "String" = "String"

serviceDiscoveryMode

serviceDiscoveryMode: object

serializedName

serializedName: string = "typeProperties.serviceDiscoveryMode"

type

type: object

name

name: "Object" = "Object"

thriftTransportProtocol

thriftTransportProtocol: object

serializedName

serializedName: string = "typeProperties.thriftTransportProtocol"

type

type: object

name

name: "String" = "String"

trustedCertPath

trustedCertPath: object

serializedName

serializedName: string = "typeProperties.trustedCertPath"

type

type: object

name

name: "Object" = "Object"

useNativeQuery

useNativeQuery: object

serializedName

serializedName: string = "typeProperties.useNativeQuery"

type

type: object

name

name: "Object" = "Object"

useSystemTrustStore

useSystemTrustStore: object

serializedName

serializedName: string = "typeProperties.useSystemTrustStore"

type

type: object

name

name: "Object" = "Object"

username

username: object

serializedName

serializedName: string = "typeProperties.username"

type

type: object

name

name: "Object" = "Object"

zooKeeperNameSpace

zooKeeperNameSpace: object

serializedName

serializedName: string = "typeProperties.zooKeeperNameSpace"

type

type: object

name

name: "Object" = "Object"

Const HiveObjectDataset

HiveObjectDataset: object
interface

An interface representing HiveObjectDataset. Hive Server dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Optional tableName

tableName: any
member

{any} [tableName] The table name. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "HiveObject"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "HiveObjectDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

tableName

tableName: object

serializedName

serializedName: string = "typeProperties.tableName"

type

type: object

name

name: "Object" = "Object"

Const HiveSource

HiveSource: object
interface

An interface representing HiveSource. A copy activity Hive Server source.

Optional query

query: any
member

{any} [query] A query to retrieve data from source. Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "HiveSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "HiveSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

Const HttpDataset

HttpDataset: object
interface

An interface representing HttpDataset. A file in an HTTP web server.

Optional additionalHeaders

additionalHeaders: any
member

{any} [additionalHeaders] The headers for the HTTP Request. e.g. request-header-name-1:request-header-value-1 ... request-header-name-n:request-header-value-n Type: string (or Expression with resultType string).

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional compression

member

{DatasetCompressionUnion} [compression] The data compression method used on files.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

Optional format

member

{DatasetStorageFormatUnion} [format] The format of files.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional relativeUrl

relativeUrl: any
member

{any} [relativeUrl] The relative URL based on the URL in the HttpLinkedService refers to an HTTP file Type: string (or Expression with resultType string).

Optional requestBody

requestBody: any
member

{any} [requestBody] The body for the HTTP request. Type: string (or Expression with resultType string).

Optional requestMethod

requestMethod: any
member

{any} [requestMethod] The HTTP method for the HTTP request. Type: string (or Expression with resultType string).

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

serializedName

serializedName: string = "HttpFile"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "HttpDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

additionalHeaders

additionalHeaders: object

serializedName

serializedName: string = "typeProperties.additionalHeaders"

type

type: object

name

name: "Object" = "Object"

compression

compression: object

serializedName

serializedName: string = "typeProperties.compression"

type

type: object

className

className: string = "DatasetCompression"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

format

format: object

serializedName

serializedName: string = "typeProperties.format"

type

type: object

className

className: string = "DatasetStorageFormat"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

relativeUrl

relativeUrl: object

serializedName

serializedName: string = "typeProperties.relativeUrl"

type

type: object

name

name: "Object" = "Object"

requestBody

requestBody: object

serializedName

serializedName: string = "typeProperties.requestBody"

type

type: object

name

name: "Object" = "Object"

requestMethod

requestMethod: object

serializedName

serializedName: string = "typeProperties.requestMethod"

type

type: object

name

name: "Object" = "Object"

Const HttpLinkedService

HttpLinkedService: object
interface

An interface representing HttpLinkedService. Linked service for an HTTP source.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional authenticationType

authenticationType: HttpAuthenticationType
member

{HttpAuthenticationType} [authenticationType] The authentication type to be used to connect to the HTTP server. Possible values include: 'Basic', 'Anonymous', 'Digest', 'Windows', 'ClientCertificate'

Optional certThumbprint

certThumbprint: any
member

{any} [certThumbprint] Thumbprint of certificate for ClientCertificate authentication. Only valid for on-premises copy. For on-premises copy with ClientCertificate authentication, either CertThumbprint or EmbeddedCertData/Password should be specified. Type: string (or Expression with resultType string).

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional embeddedCertData

embeddedCertData: any
member

{any} [embeddedCertData] Base64 encoded certificate data for ClientCertificate authentication. For on-premises copy with ClientCertificate authentication, either CertThumbprint or EmbeddedCertData/Password should be specified. Type: string (or Expression with resultType string).

Optional enableServerCertificateValidation

enableServerCertificateValidation: any
member

{any} [enableServerCertificateValidation] If true, validate the HTTPS server SSL certificate. Default value is true. Type: boolean (or Expression with resultType boolean).

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional password

password: SecretBaseUnion
member

{SecretBaseUnion} [password] Password for Basic, Digest, Windows, or ClientCertificate with EmbeddedCertData authentication.

url

url: any
member

{any} url The base URL of the HTTP endpoint, e.g. http://www.microsoft.com. Type: string (or Expression with resultType string).

Optional userName

userName: any
member

{any} [userName] User name for Basic, Digest, or Windows authentication. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "HttpServer"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "HttpLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

authenticationType

authenticationType: object

serializedName

serializedName: string = "typeProperties.authenticationType"

type

type: object

name

name: "String" = "String"

certThumbprint

certThumbprint: object

serializedName

serializedName: string = "typeProperties.certThumbprint"

type

type: object

name

name: "Object" = "Object"

embeddedCertData

embeddedCertData: object

serializedName

serializedName: string = "typeProperties.embeddedCertData"

type

type: object

name

name: "Object" = "Object"

enableServerCertificateValidation

enableServerCertificateValidation: object

serializedName

serializedName: string = "typeProperties.enableServerCertificateValidation"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

password

password: object

serializedName

serializedName: string = "typeProperties.password"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

url

url: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.url"

type

type: object

name

name: "Object" = "Object"

userName

userName: object

serializedName

serializedName: string = "typeProperties.userName"

type

type: object

name

name: "Object" = "Object"

Const HttpSource

HttpSource: object
interface

An interface representing HttpSource. A copy activity source for an HTTP file.

Optional httpRequestTimeout

httpRequestTimeout: any
member

{any} [httpRequestTimeout] Specifies the timeout for a HTTP client to get HTTP response from HTTP server. The default value is equivalent to System.Net.HttpWebRequest.Timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "HttpSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "HttpSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

httpRequestTimeout

httpRequestTimeout: object

serializedName

serializedName: string = "httpRequestTimeout"

type

type: object

name

name: "Object" = "Object"

Const HubspotLinkedService

HubspotLinkedService: object
interface

An interface representing HubspotLinkedService. Hubspot Serivce linked service.

Optional accessToken

accessToken: SecretBaseUnion
member

{SecretBaseUnion} [accessToken] The access token obtained when initially authenticating your OAuth integration.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

clientId

clientId: any
member

{any} clientId The client ID associated with your Hubspot application.

Optional clientSecret

clientSecret: SecretBaseUnion
member

{SecretBaseUnion} [clientSecret] The client secret associated with your Hubspot application.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional refreshToken

refreshToken: SecretBaseUnion
member

{SecretBaseUnion} [refreshToken] The refresh token obtained when initially authenticating your OAuth integration.

Optional useEncryptedEndpoints

useEncryptedEndpoints: any
member

{any} [useEncryptedEndpoints] Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

Optional useHostVerification

useHostVerification: any
member

{any} [useHostVerification] Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.

Optional usePeerVerification

usePeerVerification: any
member

{any} [usePeerVerification] Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

serializedName

serializedName: string = "Hubspot"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "HubspotLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

accessToken

accessToken: object

serializedName

serializedName: string = "typeProperties.accessToken"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

clientId

clientId: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.clientId"

type

type: object

name

name: "Object" = "Object"

clientSecret

clientSecret: object

serializedName

serializedName: string = "typeProperties.clientSecret"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

refreshToken

refreshToken: object

serializedName

serializedName: string = "typeProperties.refreshToken"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

useEncryptedEndpoints

useEncryptedEndpoints: object

serializedName

serializedName: string = "typeProperties.useEncryptedEndpoints"

type

type: object

name

name: "Object" = "Object"

useHostVerification

useHostVerification: object

serializedName

serializedName: string = "typeProperties.useHostVerification"

type

type: object

name

name: "Object" = "Object"

usePeerVerification

usePeerVerification: object

serializedName

serializedName: string = "typeProperties.usePeerVerification"

type

type: object

name

name: "Object" = "Object"

Const HubspotObjectDataset

HubspotObjectDataset: object
interface

An interface representing HubspotObjectDataset. Hubspot Serivce dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Optional tableName

tableName: any
member

{any} [tableName] The table name. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "HubspotObject"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "HubspotObjectDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

tableName

tableName: object

serializedName

serializedName: string = "typeProperties.tableName"

type

type: object

name

name: "Object" = "Object"

Const HubspotSource

HubspotSource: object
interface

An interface representing HubspotSource. A copy activity Hubspot Serivce source.

Optional query

query: any
member

{any} [query] A query to retrieve data from source. Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "HubspotSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "HubspotSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

Const IfConditionActivity

IfConditionActivity: object
interface

An interface representing IfConditionActivity. This activity evaluates a boolean expression and executes either the activities under the ifTrueActivities property or the ifFalseActivities property depending on the result of the expression.

Optional dependsOn

dependsOn: ActivityDependency[]
member

{ActivityDependency[]} [dependsOn] Activity depends on condition.

Optional description

description: undefined | string
member

{string} [description] Activity description.

expression

expression: Expression
member

{Expression} expression An expression that would evaluate to Boolean. This is used to determine the block of activities (ifTrueActivities or ifFalseActivities) that will be executed.

Optional ifFalseActivities

ifFalseActivities: ActivityUnion[]
member

{ActivityUnion[]} [ifFalseActivities] List of activities to execute if expression is evaluated to false. This is an optional property and if not provided, the activity will exit without any action.

Optional ifTrueActivities

ifTrueActivities: ActivityUnion[]
member

{ActivityUnion[]} [ifTrueActivities] List of activities to execute if expression is evaluated to true. This is an optional property and if not provided, the activity will exit without any action.

name

name: string
member

{string} name Activity name.

Optional userProperties

userProperties: UserProperty[]
member

{UserProperty[]} [userProperties] Activity user properties.

serializedName

serializedName: string = "IfCondition"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Activity.type.additionalProperties

className

className: string = "IfConditionActivity"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Activity.type.polymorphicDiscriminator

uberParent

uberParent: string = "Activity"

modelProperties

modelProperties: object

expression

expression: object

defaultValue

defaultValue: object

Type declaration

required

required: true = true

serializedName

serializedName: string = "typeProperties.expression"

type

type: object

className

className: string = "Expression"

name

name: "Composite" = "Composite"

ifFalseActivities

ifFalseActivities: object

serializedName

serializedName: string = "typeProperties.ifFalseActivities"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Activity"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

ifTrueActivities

ifTrueActivities: object

serializedName

serializedName: string = "typeProperties.ifTrueActivities"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Activity"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

Const ImpalaLinkedService

ImpalaLinkedService: object
interface

An interface representing ImpalaLinkedService. Impala server linked service.

Optional allowHostNameCNMismatch

allowHostNameCNMismatch: any
member

{any} [allowHostNameCNMismatch] Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.

Optional allowSelfSignedServerCert

allowSelfSignedServerCert: any
member

{any} [allowSelfSignedServerCert] Specifies whether to allow self-signed certificates from the server. The default value is false.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

authenticationType

authenticationType: ImpalaAuthenticationType
member

{ImpalaAuthenticationType} authenticationType The authentication type to use. Possible values include: 'Anonymous', 'SASLUsername', 'UsernameAndPassword'

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional enableSsl

enableSsl: any
member

{any} [enableSsl] Specifies whether the connections to the server are encrypted using SSL. The default value is false.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

host

host: any
member

{any} host The IP address or host name of the Impala server. (i.e. 192.168.222.160)

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional password

password: SecretBaseUnion
member

{SecretBaseUnion} [password] The password corresponding to the user name when using UsernameAndPassword.

Optional port

port: any
member

{any} [port] The TCP port that the Impala server uses to listen for client connections. The default value is 21050.

Optional trustedCertPath

trustedCertPath: any
member

{any} [trustedCertPath] The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.

Optional useSystemTrustStore

useSystemTrustStore: any
member

{any} [useSystemTrustStore] Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.

Optional username

username: any
member

{any} [username] The user name used to access the Impala server. The default value is anonymous when using SASLUsername.

serializedName

serializedName: string = "Impala"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "ImpalaLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

allowHostNameCNMismatch

allowHostNameCNMismatch: object

serializedName

serializedName: string = "typeProperties.allowHostNameCNMismatch"

type

type: object

name

name: "Object" = "Object"

allowSelfSignedServerCert

allowSelfSignedServerCert: object

serializedName

serializedName: string = "typeProperties.allowSelfSignedServerCert"

type

type: object

name

name: "Object" = "Object"

authenticationType

authenticationType: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.authenticationType"

type

type: object

name

name: "String" = "String"

enableSsl

enableSsl: object

serializedName

serializedName: string = "typeProperties.enableSsl"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

host

host: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.host"

type

type: object

name

name: "Object" = "Object"

password

password: object

serializedName

serializedName: string = "typeProperties.password"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

port

port: object

serializedName

serializedName: string = "typeProperties.port"

type

type: object

name

name: "Object" = "Object"

trustedCertPath

trustedCertPath: object

serializedName

serializedName: string = "typeProperties.trustedCertPath"

type

type: object

name

name: "Object" = "Object"

useSystemTrustStore

useSystemTrustStore: object

serializedName

serializedName: string = "typeProperties.useSystemTrustStore"

type

type: object

name

name: "Object" = "Object"

username

username: object

serializedName

serializedName: string = "typeProperties.username"

type

type: object

name

name: "Object" = "Object"

Const ImpalaObjectDataset

ImpalaObjectDataset: object
interface

An interface representing ImpalaObjectDataset. Impala server dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Optional tableName

tableName: any
member

{any} [tableName] The table name. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "ImpalaObject"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "ImpalaObjectDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

tableName

tableName: object

serializedName

serializedName: string = "typeProperties.tableName"

type

type: object

name

name: "Object" = "Object"

Const ImpalaSource

ImpalaSource: object
interface

An interface representing ImpalaSource. A copy activity Impala server source.

Optional query

query: any
member

{any} [query] A query to retrieve data from source. Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "ImpalaSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "ImpalaSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

Const IntegrationRuntime

IntegrationRuntime: object
interface

An interface representing IntegrationRuntime. Azure Data Factory nested object which serves as a compute resource for activities.

Optional description

description: undefined | string
member

{string} [description] Integration runtime description.

serializedName

serializedName: string = "IntegrationRuntime"

type

type: object
member

{string} type Polymorphic Discriminator

className

className: string = "IntegrationRuntime"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "IntegrationRuntime"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

type

type: object

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "type"

serializedName

serializedName: string = "type"

Const IntegrationRuntimeAuthKeys

IntegrationRuntimeAuthKeys: object
interface

An interface representing IntegrationRuntimeAuthKeys. The integration runtime authentication keys.

Optional authKey1

authKey1: undefined | string
member

{string} [authKey1] The primary integration runtime authentication key.

Optional authKey2

authKey2: undefined | string
member

{string} [authKey2] The secondary integration runtime authentication key.

serializedName

serializedName: string = "IntegrationRuntimeAuthKeys"

type

type: object

className

className: string = "IntegrationRuntimeAuthKeys"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

authKey1

authKey1: object

serializedName

serializedName: string = "authKey1"

type

type: object

name

name: "String" = "String"

authKey2

authKey2: object

serializedName

serializedName: string = "authKey2"

type

type: object

name

name: "String" = "String"

Const IntegrationRuntimeComputeProperties

IntegrationRuntimeComputeProperties: object
interface

An interface representing IntegrationRuntimeComputeProperties. The compute resource properties for managed integration runtime.

Optional location

location: undefined | string
member

{string} [location] The location for managed integration runtime. The supported regions could be found on https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities

Optional maxParallelExecutionsPerNode

maxParallelExecutionsPerNode: undefined | number
member

{number} [maxParallelExecutionsPerNode] Maximum parallel executions count per node for managed integration runtime.

Optional nodeSize

nodeSize: undefined | string
member

{string} [nodeSize] The node size requirement to managed integration runtime.

Optional numberOfNodes

numberOfNodes: undefined | number
member

{number} [numberOfNodes] The required number of nodes for managed integration runtime.

Optional vNetProperties

member

{IntegrationRuntimeVNetProperties} [vNetProperties] VNet properties for managed integration runtime.

serializedName

serializedName: string = "IntegrationRuntimeComputeProperties"

type

type: object

className

className: string = "IntegrationRuntimeComputeProperties"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

modelProperties

modelProperties: object

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

maxParallelExecutionsPerNode

maxParallelExecutionsPerNode: object

serializedName

serializedName: string = "maxParallelExecutionsPerNode"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

nodeSize

nodeSize: object

serializedName

serializedName: string = "nodeSize"

type

type: object

name

name: "String" = "String"

numberOfNodes

numberOfNodes: object

serializedName

serializedName: string = "numberOfNodes"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

vNetProperties

vNetProperties: object

serializedName

serializedName: string = "vNetProperties"

type

type: object

className

className: string = "IntegrationRuntimeVNetProperties"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

Const IntegrationRuntimeConnectionInfo

IntegrationRuntimeConnectionInfo: object
interface

An interface representing IntegrationRuntimeConnectionInfo. Connection information for encrypting the on-premises data source credentials.

Optional hostServiceUri

hostServiceUri: undefined | string
member

{string} [hostServiceUri] The on-premises integration runtime host URL. NOTE: This property will not be serialized. It can only be populated by the server.

Optional identityCertThumbprint

identityCertThumbprint: undefined | string
member

{string} [identityCertThumbprint] The integration runtime SSL certificate thumbprint. Click-Once application uses it to do server validation. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isIdentityCertExprired

isIdentityCertExprired: undefined | false | true
member

{boolean} [isIdentityCertExprired] Whether the identity certificate is expired. NOTE: This property will not be serialized. It can only be populated by the server.

Optional publicKey

publicKey: undefined | string
member

{string} [publicKey] The public key for encrypting a credential when transferring the credential to the integration runtime. NOTE: This property will not be serialized. It can only be populated by the server.

Optional serviceToken

serviceToken: undefined | string
member

{string} [serviceToken] The token generated in service. Callers use this token to authenticate to integration runtime. NOTE: This property will not be serialized. It can only be populated by the server.

Optional version

version: undefined | string
member

{string} [version] The integration runtime version. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "IntegrationRuntimeConnectionInfo"

type

type: object

className

className: string = "IntegrationRuntimeConnectionInfo"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

modelProperties

modelProperties: object

hostServiceUri

hostServiceUri: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "hostServiceUri"

type

type: object

name

name: "String" = "String"

identityCertThumbprint

identityCertThumbprint: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "identityCertThumbprint"

type

type: object

name

name: "String" = "String"

isIdentityCertExprired

isIdentityCertExprired: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "isIdentityCertExprired"

type

type: object

name

name: "Boolean" = "Boolean"

publicKey

publicKey: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "publicKey"

type

type: object

name

name: "String" = "String"

serviceToken

serviceToken: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "serviceToken"

type

type: object

name

name: "String" = "String"

version

version: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "version"

type

type: object

name

name: "String" = "String"

Const IntegrationRuntimeCustomSetupScriptProperties

IntegrationRuntimeCustomSetupScriptProperties: object
interface

An interface representing IntegrationRuntimeCustomSetupScriptProperties. Custom setup script properties for a managed dedicated integration runtime.

Optional blobContainerUri

blobContainerUri: undefined | string
member

{string} [blobContainerUri] The URI of the Azure blob container that contains the custom setup script.

Optional sasToken

sasToken: SecureString
member

{SecureString} [sasToken] The SAS token of the Azure blob container.

serializedName

serializedName: string = "IntegrationRuntimeCustomSetupScriptProperties"

type

type: object

className

className: string = "IntegrationRuntimeCustomSetupScriptProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

blobContainerUri

blobContainerUri: object

serializedName

serializedName: string = "blobContainerUri"

type

type: object

name

name: "String" = "String"

sasToken

sasToken: object

serializedName

serializedName: string = "sasToken"

type

type: object

className

className: string = "SecureString"

name

name: "Composite" = "Composite"

Const IntegrationRuntimeListResponse

IntegrationRuntimeListResponse: object
interface

An interface representing the IntegrationRuntimeListResponse. A list of integration runtime resources.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] The link to the next page of results, if any remaining results exist.

serializedName

serializedName: string = "IntegrationRuntimeListResponse"

__@iterator

  • Iterator

    Returns IterableIterator<IntegrationRuntimeResource>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns IntegrationRuntimeResource[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns IntegrationRuntimeResource[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, IntegrationRuntimeResource]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: IntegrationRuntimeResource

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    Returns IntegrationRuntimeResource[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): IntegrationRuntimeResource | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns IntegrationRuntimeResource | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: IntegrationRuntimeResource

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: IntegrationRuntimeResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: IntegrationRuntimeResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns IntegrationRuntimeResource | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

reverse

  • Reverses the elements in an Array.

    Returns IntegrationRuntimeResource[]

shift

  • Removes the first element from an array and returns it.

    Returns IntegrationRuntimeResource | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns IntegrationRuntimeResource[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns IntegrationRuntimeResource[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: IntegrationRuntimeResource[]

      Elements to insert into the array in place of the deleted elements.

    Returns IntegrationRuntimeResource[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<IntegrationRuntimeResource>

type

type: object

className

className: string = "IntegrationRuntimeListResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "IntegrationRuntimeResource"

name

name: "Composite" = "Composite"

Const IntegrationRuntimeMonitoringData

IntegrationRuntimeMonitoringData: object
interface

An interface representing IntegrationRuntimeMonitoringData. Get monitoring data response.

Optional name

name: undefined | string
member

{string} [name] Integration runtime name.

Optional nodes

member

{IntegrationRuntimeNodeMonitoringData[]} [nodes] Integration runtime node monitoring data.

serializedName

serializedName: string = "IntegrationRuntimeMonitoringData"

type

type: object

className

className: string = "IntegrationRuntimeMonitoringData"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

nodes

nodes: object

serializedName

serializedName: string = "nodes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "IntegrationRuntimeNodeMonitoringData"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

Const IntegrationRuntimeNodeIpAddress

IntegrationRuntimeNodeIpAddress: object
interface

An interface representing IntegrationRuntimeNodeIpAddress. The IP address of self-hosted integration runtime node.

Optional ipAddress

ipAddress: undefined | string
member

{string} [ipAddress] The IP address of self-hosted integration runtime node. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "IntegrationRuntimeNodeIpAddress"

type

type: object

className

className: string = "IntegrationRuntimeNodeIpAddress"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

ipAddress

ipAddress: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "ipAddress"

type

type: object

name

name: "String" = "String"

Const IntegrationRuntimeNodeMonitoringData

IntegrationRuntimeNodeMonitoringData: object
interface

An interface representing IntegrationRuntimeNodeMonitoringData. Monitoring data for integration runtime node.

Optional availableMemoryInMB

availableMemoryInMB: undefined | number
member

{number} [availableMemoryInMB] Available memory (MB) on the integration runtime node. NOTE: This property will not be serialized. It can only be populated by the server.

Optional concurrentJobsLimit

concurrentJobsLimit: undefined | number
member

{number} [concurrentJobsLimit] Maximum concurrent jobs on the integration runtime node. NOTE: This property will not be serialized. It can only be populated by the server.

Optional concurrentJobsRunning

concurrentJobsRunning: undefined | number
member

{number} [concurrentJobsRunning] The number of jobs currently running on the integration runtime node. NOTE: This property will not be serialized. It can only be populated by the server.

Optional cpuUtilization

cpuUtilization: undefined | number
member

{number} [cpuUtilization] CPU percentage on the integration runtime node. NOTE: This property will not be serialized. It can only be populated by the server.

Optional maxConcurrentJobs

maxConcurrentJobs: undefined | number
member

{number} [maxConcurrentJobs] The maximum concurrent jobs in this integration runtime. NOTE: This property will not be serialized. It can only be populated by the server.

Optional nodeName

nodeName: undefined | string
member

{string} [nodeName] Name of the integration runtime node. NOTE: This property will not be serialized. It can only be populated by the server.

Optional receivedBytes

receivedBytes: undefined | number
member

{number} [receivedBytes] Received bytes on the integration runtime node. NOTE: This property will not be serialized. It can only be populated by the server.

Optional sentBytes

sentBytes: undefined | number
member

{number} [sentBytes] Sent bytes on the integration runtime node. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "IntegrationRuntimeNodeMonitoringData"

type

type: object

className

className: string = "IntegrationRuntimeNodeMonitoringData"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

modelProperties

modelProperties: object

availableMemoryInMB

availableMemoryInMB: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "availableMemoryInMB"

type

type: object

name

name: "Number" = "Number"

concurrentJobsLimit

concurrentJobsLimit: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "concurrentJobsLimit"

type

type: object

name

name: "Number" = "Number"

concurrentJobsRunning

concurrentJobsRunning: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "concurrentJobsRunning"

type

type: object

name

name: "Number" = "Number"

cpuUtilization

cpuUtilization: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "cpuUtilization"

type

type: object

name

name: "Number" = "Number"

maxConcurrentJobs

maxConcurrentJobs: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "maxConcurrentJobs"

type

type: object

name

name: "Number" = "Number"

nodeName

nodeName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nodeName"

type

type: object

name

name: "String" = "String"

receivedBytes

receivedBytes: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "receivedBytes"

type

type: object

name

name: "Number" = "Number"

sentBytes

sentBytes: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "sentBytes"

type

type: object

name

name: "Number" = "Number"

Const IntegrationRuntimeReference

IntegrationRuntimeReference: object
interface

An interface representing IntegrationRuntimeReference. Integration runtime reference type.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: any }} [parameters] Arguments for integration runtime.

referenceName

referenceName: string
member

{string} referenceName Reference integration runtime name.

serializedName

serializedName: string = "IntegrationRuntimeReference"

type

type: object

className

className: string = "IntegrationRuntimeReference"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

parameters

parameters: object

serializedName

serializedName: string = "parameters"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Object" = "Object"

referenceName

referenceName: object

required

required: true = true

serializedName

serializedName: string = "referenceName"

type

type: object

name

name: "String" = "String"

type

type: object

defaultValue

defaultValue: string = "IntegrationRuntimeReference"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const IntegrationRuntimeRegenerateKeyParameters

IntegrationRuntimeRegenerateKeyParameters: object
interface

An interface representing IntegrationRuntimeRegenerateKeyParameters. Parameters to regenerate the authentication key.

Optional keyName

member

{IntegrationRuntimeAuthKeyName} [keyName] The name of the authentication key to regenerate. Possible values include: 'authKey1', 'authKey2'

serializedName

serializedName: string = "IntegrationRuntimeRegenerateKeyParameters"

type

type: object

className

className: string = "IntegrationRuntimeRegenerateKeyParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

keyName

keyName: object

serializedName

serializedName: string = "keyName"

type

type: object

name

name: "String" = "String"

Const IntegrationRuntimeResource

IntegrationRuntimeResource: object
interface

An interface representing IntegrationRuntimeResource. Integration runtime resource type.

extends

SubResource

Optional etag

etag: undefined | string
member

{string} [etag] Etag identifies change in the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string
member

{string} [id] The resource identifier. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string
member

{string} [name] The resource name. NOTE: This property will not be serialized. It can only be populated by the server.

properties

member

{IntegrationRuntimeUnion} properties Integration runtime properties.

serializedName

serializedName: string = "IntegrationRuntimeResource"

Optional type

type: object
member

{string} [type] The resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "IntegrationRuntimeResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

required

required: true = true

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "IntegrationRuntime"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

Const IntegrationRuntimeSsisCatalogInfo

IntegrationRuntimeSsisCatalogInfo: object
interface

An interface representing IntegrationRuntimeSsisCatalogInfo. Catalog information for managed dedicated integration runtime.

Optional catalogAdminPassword

catalogAdminPassword: SecureString
member

{SecureString} [catalogAdminPassword] The password of the administrator user account of the catalog database.

Optional catalogAdminUserName

catalogAdminUserName: undefined | string
member

{string} [catalogAdminUserName] The administrator user name of catalog database.

Optional catalogPricingTier

member

{IntegrationRuntimeSsisCatalogPricingTier} [catalogPricingTier] The pricing tier for the catalog database. The valid values could be found in https://azure.microsoft.com/en-us/pricing/details/sql-database/. Possible values include: 'Basic', 'Standard', 'Premium', 'PremiumRS'

Optional catalogServerEndpoint

catalogServerEndpoint: undefined | string
member

{string} [catalogServerEndpoint] The catalog database server URL.

serializedName

serializedName: string = "IntegrationRuntimeSsisCatalogInfo"

type

type: object

className

className: string = "IntegrationRuntimeSsisCatalogInfo"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

modelProperties

modelProperties: object

catalogAdminPassword

catalogAdminPassword: object

serializedName

serializedName: string = "catalogAdminPassword"

type

type: object

className

className: string = "SecureString"

name

name: "Composite" = "Composite"

catalogAdminUserName

catalogAdminUserName: object

serializedName

serializedName: string = "catalogAdminUserName"

constraints

constraints: object

MaxLength

MaxLength: number = 128

MinLength

MinLength: number = 1

type

type: object

name

name: "String" = "String"

catalogPricingTier

catalogPricingTier: object

serializedName

serializedName: string = "catalogPricingTier"

type

type: object

name

name: "String" = "String"

catalogServerEndpoint

catalogServerEndpoint: object

serializedName

serializedName: string = "catalogServerEndpoint"

type

type: object

name

name: "String" = "String"

Const IntegrationRuntimeSsisProperties

IntegrationRuntimeSsisProperties: object
interface

An interface representing IntegrationRuntimeSsisProperties. SSIS properties for managed integration runtime.

Optional catalogInfo

member

{IntegrationRuntimeSsisCatalogInfo} [catalogInfo] Catalog information for managed dedicated integration runtime.

Optional customSetupScriptProperties

member

{IntegrationRuntimeCustomSetupScriptProperties} [customSetupScriptProperties] Custom setup script properties for a managed dedicated integration runtime.

Optional edition

member

{IntegrationRuntimeEdition} [edition] The edition for the SSIS Integration Runtime. Possible values include: 'Standard', 'Enterprise'

Optional licenseType

member

{IntegrationRuntimeLicenseType} [licenseType] License type for bringing your own license scenario. Possible values include: 'BasePrice', 'LicenseIncluded'

serializedName

serializedName: string = "IntegrationRuntimeSsisProperties"

type

type: object

className

className: string = "IntegrationRuntimeSsisProperties"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

modelProperties

modelProperties: object

catalogInfo

catalogInfo: object

serializedName

serializedName: string = "catalogInfo"

type

type: object

className

className: string = "IntegrationRuntimeSsisCatalogInfo"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

customSetupScriptProperties

customSetupScriptProperties: object

serializedName

serializedName: string = "customSetupScriptProperties"

type

type: object

className

className: string = "IntegrationRuntimeCustomSetupScriptProperties"

name

name: "Composite" = "Composite"

edition

edition: object

serializedName

serializedName: string = "edition"

type

type: object

name

name: "String" = "String"

licenseType

licenseType: object

serializedName

serializedName: string = "licenseType"

type

type: object

name

name: "String" = "String"

Const IntegrationRuntimeStatus

IntegrationRuntimeStatus: object
interface

An interface representing IntegrationRuntimeStatus. Integration runtime status.

Optional dataFactoryName

dataFactoryName: undefined | string
member

{string} [dataFactoryName] The data factory name which the integration runtime belong to. NOTE: This property will not be serialized. It can only be populated by the server.

Optional state

member

{IntegrationRuntimeState} [state] The state of integration runtime. Possible values include: 'Initial', 'Stopped', 'Started', 'Starting', 'Stopping', 'NeedRegistration', 'Online', 'Limited', 'Offline', 'AccessDenied' NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "IntegrationRuntimeStatus"

type

type: object
member

{string} type Polymorphic Discriminator

className

className: string = "IntegrationRuntimeStatus"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "IntegrationRuntimeStatus"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

modelProperties

modelProperties: object

dataFactoryName

dataFactoryName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "dataFactoryName"

type

type: object

name

name: "String" = "String"

state

state: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "state"

type

type: object

name

name: "String" = "String"

type

type: object

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "type"

serializedName

serializedName: string = "type"

Const IntegrationRuntimeStatusListResponse

IntegrationRuntimeStatusListResponse: object
interface

An interface representing IntegrationRuntimeStatusListResponse. A list of integration runtime status.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] The link to the next page of results, if any remaining results exist.

value

member

{IntegrationRuntimeStatusResponse[]} value List of integration runtime status.

serializedName

serializedName: string = "IntegrationRuntimeStatusListResponse"

type

type: object

className

className: string = "IntegrationRuntimeStatusListResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "IntegrationRuntimeStatusResponse"

name

name: "Composite" = "Composite"

Const IntegrationRuntimeStatusResponse

IntegrationRuntimeStatusResponse: object
interface

An interface representing IntegrationRuntimeStatusResponse. Integration runtime status response.

Optional name

name: undefined | string
member

{string} [name] The integration runtime name. NOTE: This property will not be serialized. It can only be populated by the server.

properties

member

{IntegrationRuntimeStatusUnion} properties Integration runtime properties.

serializedName

serializedName: string = "IntegrationRuntimeStatusResponse"

type

type: object

className

className: string = "IntegrationRuntimeStatusResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

properties

properties: object

required

required: true = true

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "IntegrationRuntimeStatus"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

Const IntegrationRuntimeVNetProperties

IntegrationRuntimeVNetProperties: object
interface

An interface representing IntegrationRuntimeVNetProperties. VNet properties for managed integration runtime.

Optional subnet

subnet: undefined | string
member

{string} [subnet] The name of the subnet this integration runtime will join.

Optional vNetId

vNetId: undefined | string
member

{string} [vNetId] The ID of the VNet that this integration runtime will join.

serializedName

serializedName: string = "IntegrationRuntimeVNetProperties"

type

type: object

className

className: string = "IntegrationRuntimeVNetProperties"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

modelProperties

modelProperties: object

subnet

subnet: object

serializedName

serializedName: string = "subnet"

type

type: object

name

name: "String" = "String"

vNetId

vNetId: object

serializedName

serializedName: string = "vNetId"

type

type: object

name

name: "String" = "String"

Const JiraLinkedService

JiraLinkedService: object
interface

An interface representing JiraLinkedService. Jira Serivce linked service.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

host

host: any
member

{any} host The IP address or host name of the Jira service. (e.g. jira.example.com)

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional password

password: SecretBaseUnion
member

{SecretBaseUnion} [password] The password corresponding to the user name that you provided in the username field.

Optional port

port: any
member

{any} [port] The TCP port that the Jira server uses to listen for client connections. The default value is 443 if connecting through HTTPS, or 8080 if connecting through HTTP.

Optional useEncryptedEndpoints

useEncryptedEndpoints: any
member

{any} [useEncryptedEndpoints] Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

Optional useHostVerification

useHostVerification: any
member

{any} [useHostVerification] Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.

Optional usePeerVerification

usePeerVerification: any
member

{any} [usePeerVerification] Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

username

username: any
member

{any} username The user name that you use to access Jira Service.

serializedName

serializedName: string = "Jira"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "JiraLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

host

host: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.host"

type

type: object

name

name: "Object" = "Object"

password

password: object

serializedName

serializedName: string = "typeProperties.password"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

port

port: object

serializedName

serializedName: string = "typeProperties.port"

type

type: object

name

name: "Object" = "Object"

useEncryptedEndpoints

useEncryptedEndpoints: object

serializedName

serializedName: string = "typeProperties.useEncryptedEndpoints"

type

type: object

name

name: "Object" = "Object"

useHostVerification

useHostVerification: object

serializedName

serializedName: string = "typeProperties.useHostVerification"

type

type: object

name

name: "Object" = "Object"

usePeerVerification

usePeerVerification: object

serializedName

serializedName: string = "typeProperties.usePeerVerification"

type

type: object

name

name: "Object" = "Object"

username

username: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.username"

type

type: object

name

name: "Object" = "Object"

Const JiraObjectDataset

JiraObjectDataset: object
interface

An interface representing JiraObjectDataset. Jira Serivce dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Optional tableName

tableName: any
member

{any} [tableName] The table name. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "JiraObject"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "JiraObjectDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

tableName

tableName: object

serializedName

serializedName: string = "typeProperties.tableName"

type

type: object

name

name: "Object" = "Object"

Const JiraSource

JiraSource: object
interface

An interface representing JiraSource. A copy activity Jira Serivce source.

Optional query

query: any
member

{any} [query] A query to retrieve data from source. Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "JiraSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "JiraSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

Const JsonFormat

JsonFormat: object
interface

An interface representing JsonFormat. The data stored in JSON format.

Optional deserializer

deserializer: any
member

{any} [deserializer] Deserializer. Type: string (or Expression with resultType string).

Optional encodingName

encodingName: any
member

{any} [encodingName] The code page name of the preferred encoding. If not provided, the default value is 'utf-8', unless the byte order mark (BOM) denotes another Unicode encoding. The full list of supported values can be found in the 'Name' column of the table of encodings in the following reference: https://go.microsoft.com/fwlink/?linkid=861078. Type: string (or Expression with resultType string).

Optional filePattern

member

{JsonFormatFilePattern} [filePattern] File pattern of JSON. To be more specific, the way of separating a collection of JSON objects. The default value is 'setOfObjects'. It is case-sensitive. Possible values include: 'setOfObjects', 'arrayOfObjects'

Optional jsonNodeReference

jsonNodeReference: any
member

{any} [jsonNodeReference] The JSONPath of the JSON array element to be flattened. Example: "$.ArrayPath". Type: string (or Expression with resultType string).

Optional jsonPathDefinition

jsonPathDefinition: any
member

{any} [jsonPathDefinition] The JSONPath definition for each column mapping with a customized column name to extract data from JSON file. For fields under root object, start with "$"; for fields inside the array chosen by jsonNodeReference property, start from the array element. Example: {"Column1": "$.Column1Path", "Column2": "Column2PathInArray"}. Type: object (or Expression with resultType object).

Optional nestingSeparator

nestingSeparator: any
member

{any} [nestingSeparator] The character used to separate nesting levels. Default value is '.' (dot). Type: string (or Expression with resultType string).

Optional serializer

serializer: any
member

{any} [serializer] Serializer. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "JsonFormat"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = DatasetStorageFormat.type.additionalProperties

className

className: string = "JsonFormat"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = DatasetStorageFormat.type.polymorphicDiscriminator

uberParent

uberParent: string = "DatasetStorageFormat"

modelProperties

modelProperties: object

encodingName

encodingName: object

serializedName

serializedName: string = "encodingName"

type

type: object

name

name: "Object" = "Object"

filePattern

filePattern: object

serializedName

serializedName: string = "filePattern"

type

type: object

name

name: "String" = "String"

jsonNodeReference

jsonNodeReference: object

serializedName

serializedName: string = "jsonNodeReference"

type

type: object

name

name: "Object" = "Object"

jsonPathDefinition

jsonPathDefinition: object

serializedName

serializedName: string = "jsonPathDefinition"

type

type: object

name

name: "Object" = "Object"

nestingSeparator

nestingSeparator: object

serializedName

serializedName: string = "nestingSeparator"

type

type: object

name

name: "Object" = "Object"

Const LinkedIntegrationRuntime

LinkedIntegrationRuntime: object
interface

An interface representing LinkedIntegrationRuntime. The linked integration runtime information.

Optional createTime

createTime: Date
member

{Date} [createTime] The creating time of the linked integration runtime. NOTE: This property will not be serialized. It can only be populated by the server.

Optional dataFactoryLocation

dataFactoryLocation: undefined | string
member

{string} [dataFactoryLocation] The location of the data factory for which the linked integration runtime belong to. NOTE: This property will not be serialized. It can only be populated by the server.

Optional dataFactoryName

dataFactoryName: undefined | string
member

{string} [dataFactoryName] The name of the data factory for which the linked integration runtime belong to. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string
member

{string} [name] The name of the linked integration runtime. NOTE: This property will not be serialized. It can only be populated by the server.

Optional subscriptionId

subscriptionId: undefined | string
member

{string} [subscriptionId] The subscription ID for which the linked integration runtime belong to. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "LinkedIntegrationRuntime"

type

type: object

className

className: string = "LinkedIntegrationRuntime"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

createTime

createTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "createTime"

type

type: object

name

name: "DateTime" = "DateTime"

dataFactoryLocation

dataFactoryLocation: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "dataFactoryLocation"

type

type: object

name

name: "String" = "String"

dataFactoryName

dataFactoryName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "dataFactoryName"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

subscriptionId

subscriptionId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "subscriptionId"

type

type: object

name

name: "String" = "String"

Const LinkedIntegrationRuntimeKeyAuthorization

LinkedIntegrationRuntimeKeyAuthorization: object
interface

An interface representing LinkedIntegrationRuntimeKeyAuthorization. The key authorization type integration runtime.

authorizationType

authorizationType: "Key"
member

{string} authorizationType Polymorphic Discriminator

key

member

{SecureString} key The key used for authorization.

serializedName

serializedName: string = "Key"

type

type: object

className

className: string = "LinkedIntegrationRuntimeKeyAuthorization"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedIntegrationRuntimeType.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedIntegrationRuntimeType"

modelProperties

modelProperties: object

key

key: object

required

required: true = true

serializedName

serializedName: string = "key"

type

type: object

className

className: string = "SecureString"

name

name: "Composite" = "Composite"

Const LinkedIntegrationRuntimeRbacAuthorization

LinkedIntegrationRuntimeRbacAuthorization: object
interface

An interface representing LinkedIntegrationRuntimeRbacAuthorization. The role based access control (RBAC) authorization type integration runtime.

authorizationType

authorizationType: "RBAC"
member

{string} authorizationType Polymorphic Discriminator

resourceId

resourceId: string
member

{string} resourceId The resource identifier of the integration runtime to be shared.

serializedName

serializedName: string = "RBAC"

type

type: object

className

className: string = "LinkedIntegrationRuntimeRbacAuthorization"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedIntegrationRuntimeType.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedIntegrationRuntimeType"

modelProperties

modelProperties: object

resourceId

resourceId: object

required

required: true = true

serializedName

serializedName: string = "resourceId"

type

type: object

name

name: "String" = "String"

Const LinkedIntegrationRuntimeRequest

LinkedIntegrationRuntimeRequest: object
interface

An interface representing LinkedIntegrationRuntimeRequest. Data factory name for linked integration runtime request.

linkedFactoryName

linkedFactoryName: string
member

{string} linkedFactoryName The data factory name for linked integration runtime.

serializedName

serializedName: string = "LinkedIntegrationRuntimeRequest"

type

type: object

className

className: string = "LinkedIntegrationRuntimeRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

linkedFactoryName

linkedFactoryName: object

required

required: true = true

serializedName

serializedName: string = "factoryName"

type

type: object

name

name: "String" = "String"

Const LinkedIntegrationRuntimeType

LinkedIntegrationRuntimeType: object
interface

An interface representing LinkedIntegrationRuntimeType. The base definition of a linked integration runtime.

authorizationType

authorizationType: "LinkedIntegrationRuntimeType"
member

{string} authorizationType Polymorphic Discriminator

serializedName

serializedName: string = "LinkedIntegrationRuntimeType"

type

type: object

className

className: string = "LinkedIntegrationRuntimeType"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "LinkedIntegrationRuntimeType"

modelProperties

modelProperties: object

authorizationType

authorizationType: object

required

required: true = true

serializedName

serializedName: string = "authorizationType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "authorizationType"

serializedName

serializedName: string = "authorizationType"

Const LinkedService

LinkedService: object
interface

An interface representing LinkedService. The Azure Data Factory nested object which contains the information and credential which can be used to connect with related store or compute resource.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

serializedName

serializedName: string = "LinkedService"

type

type: object
member

{string} type Polymorphic Discriminator

className

className: string = "LinkedService"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "LinkedService"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

modelProperties

modelProperties: object

annotations

annotations: object

serializedName

serializedName: string = "annotations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "Object" = "Object"

connectVia

connectVia: object

serializedName

serializedName: string = "connectVia"

type

type: object

className

className: string = "IntegrationRuntimeReference"

name

name: "Composite" = "Composite"

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

parameters

parameters: object

serializedName

serializedName: string = "parameters"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

className

className: string = "ParameterSpecification"

name

name: "Composite" = "Composite"

type

type: object

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "type"

serializedName

serializedName: string = "type"

Const LinkedServiceListResponse

LinkedServiceListResponse: object
interface

An interface representing the LinkedServiceListResponse. A list of linked service resources.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] The link to the next page of results, if any remaining results exist.

serializedName

serializedName: string = "LinkedServiceListResponse"

__@iterator

  • Iterator

    Returns IterableIterator<LinkedServiceResource>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns LinkedServiceResource[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns LinkedServiceResource[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, LinkedServiceResource]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: LinkedServiceResource

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): LinkedServiceResource[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns LinkedServiceResource[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): LinkedServiceResource | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns LinkedServiceResource | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: LinkedServiceResource

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: LinkedServiceResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: LinkedServiceResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns LinkedServiceResource | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns LinkedServiceResource

  • Parameters

    Returns LinkedServiceResource

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns LinkedServiceResource[]

shift

  • Removes the first element from an array and returns it.

    Returns LinkedServiceResource | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns LinkedServiceResource[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns LinkedServiceResource[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: LinkedServiceResource[]

      Elements to insert into the array in place of the deleted elements.

    Returns LinkedServiceResource[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<LinkedServiceResource>

type

type: object

className

className: string = "LinkedServiceListResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LinkedServiceResource"

name

name: "Composite" = "Composite"

Const LinkedServiceReference

LinkedServiceReference: object
interface

An interface representing LinkedServiceReference. Linked service reference type.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: any }} [parameters] Arguments for LinkedService.

referenceName

referenceName: string
member

{string} referenceName Reference LinkedService name.

serializedName

serializedName: string = "LinkedServiceReference"

type

type: object

className

className: string = "LinkedServiceReference"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

parameters

parameters: object

serializedName

serializedName: string = "parameters"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Object" = "Object"

referenceName

referenceName: object

required

required: true = true

serializedName

serializedName: string = "referenceName"

type

type: object

name

name: "String" = "String"

type

type: object

defaultValue

defaultValue: string = "LinkedServiceReference"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const LinkedServiceResource

LinkedServiceResource: object
interface

An interface representing LinkedServiceResource. Linked service resource type.

extends

SubResource

Optional etag

etag: undefined | string
member

{string} [etag] Etag identifies change in the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string
member

{string} [id] The resource identifier. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string
member

{string} [name] The resource name. NOTE: This property will not be serialized. It can only be populated by the server.

properties

properties: LinkedServiceUnion
member

{LinkedServiceUnion} properties Properties of linked service.

serializedName

serializedName: string = "LinkedServiceResource"

Optional type

type: object
member

{string} [type] The resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "LinkedServiceResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

defaultValue

defaultValue: object

Type declaration

required

required: true = true

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "LinkedService"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

Const LookupActivity

LookupActivity: object
interface

An interface representing LookupActivity. Lookup activity.

dataset

member

{DatasetReference} dataset Lookup activity dataset reference.

Optional dependsOn

dependsOn: ActivityDependency[]
member

{ActivityDependency[]} [dependsOn] Activity depends on condition.

Optional description

description: undefined | string
member

{string} [description] Activity description.

Optional firstRowOnly

firstRowOnly: any
member

{any} [firstRowOnly] Whether to return first row or all rows. Default value is true. Type: boolean (or Expression with resultType boolean).

Optional linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} [linkedServiceName] Linked service reference.

name

name: string
member

{string} name Activity name.

Optional policy

member

{ActivityPolicy} [policy] Activity policy.

source

member

{CopySourceUnion} source Dataset-specific source properties, same as copy activity source.

Optional userProperties

userProperties: UserProperty[]
member

{UserProperty[]} [userProperties] Activity user properties.

serializedName

serializedName: string = "Lookup"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Activity.type.additionalProperties

className

className: string = "LookupActivity"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Activity.type.polymorphicDiscriminator

uberParent

uberParent: string = "Activity"

modelProperties

modelProperties: object

dataset

dataset: object

defaultValue

defaultValue: object

Type declaration

required

required: true = true

serializedName

serializedName: string = "typeProperties.dataset"

type

type: object

className

className: string = "DatasetReference"

name

name: "Composite" = "Composite"

firstRowOnly

firstRowOnly: object

serializedName

serializedName: string = "typeProperties.firstRowOnly"

type

type: object

name

name: "Object" = "Object"

source

source: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.source"

type

type: object

className

className: string = "CopySource"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

Const MagentoLinkedService

MagentoLinkedService: object
interface

An interface representing MagentoLinkedService. Magento server linked service.

Optional accessToken

accessToken: SecretBaseUnion
member

{SecretBaseUnion} [accessToken] The access token from Magento.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

host

host: any
member

{any} host The URL of the Magento instance. (i.e. 192.168.222.110/magento3)

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional useEncryptedEndpoints

useEncryptedEndpoints: any
member

{any} [useEncryptedEndpoints] Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

Optional useHostVerification

useHostVerification: any
member

{any} [useHostVerification] Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.

Optional usePeerVerification

usePeerVerification: any
member

{any} [usePeerVerification] Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

serializedName

serializedName: string = "Magento"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "MagentoLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

accessToken

accessToken: object

serializedName

serializedName: string = "typeProperties.accessToken"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

host

host: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.host"

type

type: object

name

name: "Object" = "Object"

useEncryptedEndpoints

useEncryptedEndpoints: object

serializedName

serializedName: string = "typeProperties.useEncryptedEndpoints"

type

type: object

name

name: "Object" = "Object"

useHostVerification

useHostVerification: object

serializedName

serializedName: string = "typeProperties.useHostVerification"

type

type: object

name

name: "Object" = "Object"

usePeerVerification

usePeerVerification: object

serializedName

serializedName: string = "typeProperties.usePeerVerification"

type

type: object

name

name: "Object" = "Object"

Const MagentoObjectDataset

MagentoObjectDataset: object
interface

An interface representing MagentoObjectDataset. Magento server dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Optional tableName

tableName: any
member

{any} [tableName] The table name. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "MagentoObject"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "MagentoObjectDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

tableName

tableName: object

serializedName

serializedName: string = "typeProperties.tableName"

type

type: object

name

name: "Object" = "Object"

Const MagentoSource

MagentoSource: object
interface

An interface representing MagentoSource. A copy activity Magento server source.

Optional query

query: any
member

{any} [query] A query to retrieve data from source. Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "MagentoSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "MagentoSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

Const ManagedIntegrationRuntime

ManagedIntegrationRuntime: object
interface

An interface representing ManagedIntegrationRuntime. Managed integration runtime, including managed elastic and managed dedicated integration runtimes.

Optional computeProperties

member

{IntegrationRuntimeComputeProperties} [computeProperties] The compute resource for managed integration runtime.

Optional description

description: undefined | string
member

{string} [description] Integration runtime description.

Optional ssisProperties

member

{IntegrationRuntimeSsisProperties} [ssisProperties] SSIS properties for managed integration runtime.

Optional state

member

{IntegrationRuntimeState} [state] Integration runtime state, only valid for managed dedicated integration runtime. Possible values include: 'Initial', 'Stopped', 'Started', 'Starting', 'Stopping', 'NeedRegistration', 'Online', 'Limited', 'Offline', 'AccessDenied' NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Managed"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = IntegrationRuntime.type.additionalProperties

className

className: string = "ManagedIntegrationRuntime"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = IntegrationRuntime.type.polymorphicDiscriminator

uberParent

uberParent: string = "IntegrationRuntime"

modelProperties

modelProperties: object

computeProperties

computeProperties: object

serializedName

serializedName: string = "typeProperties.computeProperties"

type

type: object

className

className: string = "IntegrationRuntimeComputeProperties"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

ssisProperties

ssisProperties: object

serializedName

serializedName: string = "typeProperties.ssisProperties"

type

type: object

className

className: string = "IntegrationRuntimeSsisProperties"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

state

state: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "state"

type

type: object

name

name: "String" = "String"

Const ManagedIntegrationRuntimeError

ManagedIntegrationRuntimeError: object
interface

An interface representing ManagedIntegrationRuntimeError. Error definition for managed integration runtime.

Optional code

code: undefined | string
member

{string} [code] Error code. NOTE: This property will not be serialized. It can only be populated by the server.

Optional message

message: undefined | string
member

{string} [message] Error message. NOTE: This property will not be serialized. It can only be populated by the server.

Optional parameters

parameters: string[]
member

{string[]} [parameters] Managed integration runtime error parameters. NOTE: This property will not be serialized. It can only be populated by the server.

Optional time

time: Date
member

{Date} [time] The time when the error occurred. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ManagedIntegrationRuntimeError"

type

type: object

className

className: string = "ManagedIntegrationRuntimeError"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

modelProperties

modelProperties: object

code

code: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

message

message: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

parameters

parameters: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "parameters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

time

time: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "time"

type

type: object

name

name: "DateTime" = "DateTime"

Const ManagedIntegrationRuntimeNode

ManagedIntegrationRuntimeNode: object
interface

An interface representing ManagedIntegrationRuntimeNode. Properties of integration runtime node.

Optional errors

member

{ManagedIntegrationRuntimeError[]} [errors] The errors that occurred on this integration runtime node.

Optional nodeId

nodeId: undefined | string
member

{string} [nodeId] The managed integration runtime node id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional status

member

{ManagedIntegrationRuntimeNodeStatus} [status] The managed integration runtime node status. Possible values include: 'Starting', 'Available', 'Recycling', 'Unavailable' NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ManagedIntegrationRuntimeNode"

type

type: object

className

className: string = "ManagedIntegrationRuntimeNode"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

modelProperties

modelProperties: object

errors

errors: object

serializedName

serializedName: string = "errors"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ManagedIntegrationRuntimeError"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

nodeId

nodeId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nodeId"

type

type: object

name

name: "String" = "String"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

Const ManagedIntegrationRuntimeOperationResult

ManagedIntegrationRuntimeOperationResult: object
interface

An interface representing ManagedIntegrationRuntimeOperationResult. Properties of managed integration runtime operation result.

Optional activityId

activityId: undefined | string
member

{string} [activityId] The activity id for the operation request. NOTE: This property will not be serialized. It can only be populated by the server.

Optional errorCode

errorCode: undefined | string
member

{string} [errorCode] The error code. NOTE: This property will not be serialized. It can only be populated by the server.

Optional parameters

parameters: string[]
member

{string[]} [parameters] Managed integration runtime error parameters. NOTE: This property will not be serialized. It can only be populated by the server.

Optional result

result: undefined | string
member

{string} [result] The operation result. NOTE: This property will not be serialized. It can only be populated by the server.

Optional startTime

startTime: Date
member

{Date} [startTime] The start time of the operation. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ManagedIntegrationRuntimeOperationResult"

Optional type

type: object
member

{string} [type] The operation type. Could be start or stop. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ManagedIntegrationRuntimeOperationResult"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

modelProperties

modelProperties: object

activityId

activityId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "activityId"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "errorCode"

type

type: object

name

name: "String" = "String"

parameters

parameters: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "parameters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

result

result: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "result"

type

type: object

name

name: "String" = "String"

startTime

startTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ManagedIntegrationRuntimeStatus

ManagedIntegrationRuntimeStatus: object
interface

An interface representing ManagedIntegrationRuntimeStatus. Managed integration runtime status.

Optional createTime

createTime: Date
member

{Date} [createTime] The time at which the integration runtime was created, in ISO8601 format. NOTE: This property will not be serialized. It can only be populated by the server.

Optional dataFactoryName

dataFactoryName: undefined | string
member

{string} [dataFactoryName] The data factory name which the integration runtime belong to. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastOperation

member

{ManagedIntegrationRuntimeOperationResult} [lastOperation] The last operation result that occurred on this integration runtime. NOTE: This property will not be serialized. It can only be populated by the server.

Optional nodes

member

{ManagedIntegrationRuntimeNode[]} [nodes] The list of nodes for managed integration runtime. NOTE: This property will not be serialized. It can only be populated by the server.

Optional otherErrors

member

{ManagedIntegrationRuntimeError[]} [otherErrors] The errors that occurred on this integration runtime. NOTE: This property will not be serialized. It can only be populated by the server.

Optional state

member

{IntegrationRuntimeState} [state] The state of integration runtime. Possible values include: 'Initial', 'Stopped', 'Started', 'Starting', 'Stopping', 'NeedRegistration', 'Online', 'Limited', 'Offline', 'AccessDenied' NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Managed"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = IntegrationRuntimeStatus.type.additionalProperties

className

className: string = "ManagedIntegrationRuntimeStatus"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = IntegrationRuntimeStatus.type.polymorphicDiscriminator

uberParent

uberParent: string = "IntegrationRuntimeStatus"

modelProperties

modelProperties: object

createTime

createTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "typeProperties.createTime"

type

type: object

name

name: "DateTime" = "DateTime"

lastOperation

lastOperation: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "typeProperties.lastOperation"

type

type: object

className

className: string = "ManagedIntegrationRuntimeOperationResult"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

nodes

nodes: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "typeProperties.nodes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ManagedIntegrationRuntimeNode"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

otherErrors

otherErrors: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "typeProperties.otherErrors"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ManagedIntegrationRuntimeError"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

Const MariaDBLinkedService

MariaDBLinkedService: object
interface

An interface representing MariaDBLinkedService. MariaDB server linked service.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional connectionString

connectionString: any
member

{any} [connectionString] An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional pwd

member

{AzureKeyVaultSecretReference} [pwd] The Azure key vault secret reference of password in connection string.

serializedName

serializedName: string = "MariaDB"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "MariaDBLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

connectionString

connectionString: object

serializedName

serializedName: string = "typeProperties.connectionString"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

pwd

pwd: object

serializedName

serializedName: string = "typeProperties.pwd"

type

type: object

className

className: string = "AzureKeyVaultSecretReference"

name

name: "Composite" = "Composite"

Const MariaDBSource

MariaDBSource: object
interface

An interface representing MariaDBSource. A copy activity MariaDB server source.

Optional query

query: any
member

{any} [query] A query to retrieve data from source. Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "MariaDBSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "MariaDBSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

Const MariaDBTableDataset

MariaDBTableDataset: object
interface

An interface representing MariaDBTableDataset. MariaDB server dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Optional tableName

tableName: any
member

{any} [tableName] The table name. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "MariaDBTable"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "MariaDBTableDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

tableName

tableName: object

serializedName

serializedName: string = "typeProperties.tableName"

type

type: object

name

name: "Object" = "Object"

Const MarketoLinkedService

MarketoLinkedService: object
interface

An interface representing MarketoLinkedService. Marketo server linked service.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

clientId

clientId: any
member

{any} clientId The client Id of your Marketo service.

Optional clientSecret

clientSecret: SecretBaseUnion
member

{SecretBaseUnion} [clientSecret] The client secret of your Marketo service.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

endpoint

endpoint: any
member

{any} endpoint The endpoint of the Marketo server. (i.e. 123-ABC-321.mktorest.com)

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional useEncryptedEndpoints

useEncryptedEndpoints: any
member

{any} [useEncryptedEndpoints] Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

Optional useHostVerification

useHostVerification: any
member

{any} [useHostVerification] Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.

Optional usePeerVerification

usePeerVerification: any
member

{any} [usePeerVerification] Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

serializedName

serializedName: string = "Marketo"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "MarketoLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

clientId

clientId: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.clientId"

type

type: object

name

name: "Object" = "Object"

clientSecret

clientSecret: object

serializedName

serializedName: string = "typeProperties.clientSecret"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

endpoint

endpoint: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.endpoint"

type

type: object

name

name: "Object" = "Object"

useEncryptedEndpoints

useEncryptedEndpoints: object

serializedName

serializedName: string = "typeProperties.useEncryptedEndpoints"

type

type: object

name

name: "Object" = "Object"

useHostVerification

useHostVerification: object

serializedName

serializedName: string = "typeProperties.useHostVerification"

type

type: object

name

name: "Object" = "Object"

usePeerVerification

usePeerVerification: object

serializedName

serializedName: string = "typeProperties.usePeerVerification"

type

type: object

name

name: "Object" = "Object"

Const MarketoObjectDataset

MarketoObjectDataset: object
interface

An interface representing MarketoObjectDataset. Marketo server dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Optional tableName

tableName: any
member

{any} [tableName] The table name. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "MarketoObject"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "MarketoObjectDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

tableName

tableName: object

serializedName

serializedName: string = "typeProperties.tableName"

type

type: object

name

name: "Object" = "Object"

Const MarketoSource

MarketoSource: object
interface

An interface representing MarketoSource. A copy activity Marketo server source.

Optional query

query: any
member

{any} [query] A query to retrieve data from source. Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "MarketoSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "MarketoSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

Const MongoDbCollectionDataset

MongoDbCollectionDataset: object
interface

An interface representing MongoDbCollectionDataset. The MongoDB database dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

collectionName

collectionName: any
member

{any} collectionName The table name of the MongoDB database. Type: string (or Expression with resultType string).

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

serializedName

serializedName: string = "MongoDbCollection"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "MongoDbCollectionDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

collectionName

collectionName: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.collectionName"

type

type: object

name

name: "Object" = "Object"

Const MongoDbLinkedService

MongoDbLinkedService: object
interface

An interface representing MongoDbLinkedService. Linked service for MongoDb data source.

Optional allowSelfSignedServerCert

allowSelfSignedServerCert: any
member

{any} [allowSelfSignedServerCert] Specifies whether to allow self-signed certificates from the server. The default value is false. Type: boolean (or Expression with resultType boolean).

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional authSource

authSource: any
member

{any} [authSource] Database to verify the username and password. Type: string (or Expression with resultType string).

Optional authenticationType

authenticationType: MongoDbAuthenticationType
member

{MongoDbAuthenticationType} [authenticationType] The authentication type to be used to connect to the MongoDB database. Possible values include: 'Basic', 'Anonymous'

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

databaseName

databaseName: any
member

{any} databaseName The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string).

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional enableSsl

enableSsl: any
member

{any} [enableSsl] Specifies whether the connections to the server are encrypted using SSL. The default value is false. Type: boolean (or Expression with resultType boolean).

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional password

password: SecretBaseUnion
member

{SecretBaseUnion} [password] Password for authentication.

Optional port

port: any
member

{any} [port] The TCP port number that the MongoDB server uses to listen for client connections. The default value is 27017. Type: integer (or Expression with resultType integer), minimum: 0.

server

server: any
member

{any} server The IP address or server name of the MongoDB server. Type: string (or Expression with resultType string).

Optional username

username: any
member

{any} [username] Username for authentication. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "MongoDb"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "MongoDbLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

allowSelfSignedServerCert

allowSelfSignedServerCert: object

serializedName

serializedName: string = "typeProperties.allowSelfSignedServerCert"

type

type: object

name

name: "Object" = "Object"

authSource

authSource: object

serializedName

serializedName: string = "typeProperties.authSource"

type

type: object

name

name: "Object" = "Object"

authenticationType

authenticationType: object

serializedName

serializedName: string = "typeProperties.authenticationType"

type

type: object

name

name: "String" = "String"

databaseName

databaseName: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.databaseName"

type

type: object

name

name: "Object" = "Object"

enableSsl

enableSsl: object

serializedName

serializedName: string = "typeProperties.enableSsl"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

password

password: object

serializedName

serializedName: string = "typeProperties.password"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

port

port: object

serializedName

serializedName: string = "typeProperties.port"

type

type: object

name

name: "Object" = "Object"

server

server: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.server"

type

type: object

name

name: "Object" = "Object"

username

username: object

serializedName

serializedName: string = "typeProperties.username"

type

type: object

name

name: "Object" = "Object"

Const MongoDbSource

MongoDbSource: object
interface

An interface representing MongoDbSource. A copy activity source for a MongoDB database.

Optional query

query: any
member

{any} [query] Database query. Should be a SQL-92 query expression. Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "MongoDbSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "MongoDbSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

Const MultiplePipelineTrigger

MultiplePipelineTrigger: object
interface

An interface representing MultiplePipelineTrigger. Base class for all triggers that support one to many model for trigger to pipeline.

Optional description

description: undefined | string
member

{string} [description] Trigger description.

Optional pipelines

member

{TriggerPipelineReference[]} [pipelines] Pipelines that need to be started.

Optional runtimeState

runtimeState: TriggerRuntimeState
member

{TriggerRuntimeState} [runtimeState] Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. Possible values include: 'Started', 'Stopped', 'Disabled' NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "MultiplePipelineTrigger"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Trigger.type.additionalProperties

className

className: string = "MultiplePipelineTrigger"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Trigger.type.polymorphicDiscriminator

uberParent

uberParent: string = "Trigger"

modelProperties

modelProperties: object

pipelines

pipelines: object

serializedName

serializedName: string = "pipelines"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TriggerPipelineReference"

name

name: "Composite" = "Composite"

Const MySqlLinkedService

MySqlLinkedService: object
interface

An interface representing MySqlLinkedService. Linked service for MySQL data source.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

connectionString

connectionString: SecretBaseUnion
member

{SecretBaseUnion} connectionString The connection string.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional password

member

{AzureKeyVaultSecretReference} [password] The Azure key vault secret reference of password in connection string.

serializedName

serializedName: string = "MySql"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "MySqlLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

connectionString

connectionString: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.connectionString"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

password

password: object

serializedName

serializedName: string = "typeProperties.password"

type

type: object

className

className: string = "AzureKeyVaultSecretReference"

name

name: "Composite" = "Composite"

Const NetezzaLinkedService

NetezzaLinkedService: object
interface

An interface representing NetezzaLinkedService. Netezza linked service.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional connectionString

connectionString: any
member

{any} [connectionString] An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional pwd

member

{AzureKeyVaultSecretReference} [pwd] The Azure key vault secret reference of password in connection string.

serializedName

serializedName: string = "Netezza"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "NetezzaLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

connectionString

connectionString: object

serializedName

serializedName: string = "typeProperties.connectionString"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

pwd

pwd: object

serializedName

serializedName: string = "typeProperties.pwd"

type

type: object

className

className: string = "AzureKeyVaultSecretReference"

name

name: "Composite" = "Composite"

Const NetezzaSource

NetezzaSource: object
interface

An interface representing NetezzaSource. A copy activity Netezza source.

Optional query

query: any
member

{any} [query] A query to retrieve data from source. Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "NetezzaSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "NetezzaSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

Const NetezzaTableDataset

NetezzaTableDataset: object
interface

An interface representing NetezzaTableDataset. Netezza dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Optional tableName

tableName: any
member

{any} [tableName] The table name. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "NetezzaTable"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "NetezzaTableDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

tableName

tableName: object

serializedName

serializedName: string = "typeProperties.tableName"

type

type: object

name

name: "Object" = "Object"

Const ODataLinkedService

ODataLinkedService: object
interface

An interface representing ODataLinkedService. Open Data Protocol (OData) linked service.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional authenticationType

authenticationType: ODataAuthenticationType
member

{ODataAuthenticationType} [authenticationType] Type of authentication used to connect to the OData service. Possible values include: 'Basic', 'Anonymous'

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional password

password: SecretBaseUnion
member

{SecretBaseUnion} [password] Password of the OData service.

url

url: any
member

{any} url The URL of the OData service endpoint. Type: string (or Expression with resultType string).

Optional userName

userName: any
member

{any} [userName] User name of the OData service. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "OData"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "ODataLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

authenticationType

authenticationType: object

serializedName

serializedName: string = "typeProperties.authenticationType"

type

type: object

name

name: "String" = "String"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

password

password: object

serializedName

serializedName: string = "typeProperties.password"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

url

url: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.url"

type

type: object

name

name: "Object" = "Object"

userName

userName: object

serializedName

serializedName: string = "typeProperties.userName"

type

type: object

name

name: "Object" = "Object"

Const ODataResourceDataset

ODataResourceDataset: object
interface

An interface representing ODataResourceDataset. The Open Data Protocol (OData) resource dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional path

path: any
member

{any} [path] The OData resource path. Type: string (or Expression with resultType string).

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

serializedName

serializedName: string = "ODataResource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "ODataResourceDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

path

path: object

serializedName

serializedName: string = "typeProperties.path"

type

type: object

name

name: "Object" = "Object"

Const OdbcLinkedService

OdbcLinkedService: object
interface

An interface representing OdbcLinkedService. Open Database Connectivity (ODBC) linked service.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional authenticationType

authenticationType: any
member

{any} [authenticationType] Type of authentication used to connect to the ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string).

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

connectionString

connectionString: any
member

{any} connectionString The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, SecureString or AzureKeyVaultSecretReference.

Optional credential

credential: SecretBaseUnion
member

{SecretBaseUnion} [credential] The access credential portion of the connection string specified in driver-specific property-value format.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional password

password: SecretBaseUnion
member

{SecretBaseUnion} [password] Password for Basic authentication.

Optional userName

userName: any
member

{any} [userName] User name for Basic authentication. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "Odbc"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "OdbcLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

authenticationType

authenticationType: object

serializedName

serializedName: string = "typeProperties.authenticationType"

type

type: object

name

name: "Object" = "Object"

connectionString

connectionString: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.connectionString"

type

type: object

name

name: "Object" = "Object"

credential

credential: object

serializedName

serializedName: string = "typeProperties.credential"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

password

password: object

serializedName

serializedName: string = "typeProperties.password"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

userName

userName: object

serializedName

serializedName: string = "typeProperties.userName"

type

type: object

name

name: "Object" = "Object"

Const OdbcSink

OdbcSink: object
interface

An interface representing OdbcSink. A copy activity ODBC sink.

Optional preCopyScript

preCopyScript: any
member

{any} [preCopyScript] A query to execute before starting the copy. Type: string (or Expression with resultType string).

Optional sinkRetryCount

sinkRetryCount: any
member

{any} [sinkRetryCount] Sink retry count. Type: integer (or Expression with resultType integer).

Optional sinkRetryWait

sinkRetryWait: any
member

{any} [sinkRetryWait] Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Optional writeBatchSize

writeBatchSize: any
member

{any} [writeBatchSize] Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

Optional writeBatchTimeout

writeBatchTimeout: any
member

{any} [writeBatchTimeout] Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "OdbcSink"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySink.type.additionalProperties

className

className: string = "OdbcSink"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySink.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySink"

modelProperties

modelProperties: object

preCopyScript

preCopyScript: object

serializedName

serializedName: string = "preCopyScript"

type

type: object

name

name: "Object" = "Object"

Const Operation

Operation: object
interface

An interface representing Operation. Azure Data Factory API operation definition.

Optional display

member

{OperationDisplay} [display] Metadata associated with the operation.

Optional name

name: undefined | string
member

{string} [name] Operation name: {provider}/{resource}/{operation}

Optional origin

origin: undefined | string
member

{string} [origin] The intended executor of the operation.

Optional serviceSpecification

serviceSpecification: OperationServiceSpecification
member

{OperationServiceSpecification} [serviceSpecification] Details about a service operation.

serializedName

serializedName: string = "Operation"

type

type: object

className

className: string = "Operation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

display

display: object

serializedName

serializedName: string = "display"

type

type: object

className

className: string = "OperationDisplay"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

origin

origin: object

serializedName

serializedName: string = "origin"

type

type: object

name

name: "String" = "String"

serviceSpecification

serviceSpecification: object

serializedName

serializedName: string = "properties.serviceSpecification"

type

type: object

className

className: string = "OperationServiceSpecification"

name

name: "Composite" = "Composite"

Const OperationDisplay

OperationDisplay: object
interface

An interface representing OperationDisplay. Metadata associated with the operation.

Optional description

description: undefined | string
member

{string} [description] The description of the operation.

Optional operation

operation: undefined | string
member

{string} [operation] The type of operation: get, read, delete, etc.

Optional provider

provider: undefined | string
member

{string} [provider] The name of the provider.

Optional resource

resource: undefined | string
member

{string} [resource] The name of the resource type on which the operation is performed.

serializedName

serializedName: string = "Operation_display"

type

type: object

className

className: string = "OperationDisplay"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

operation

operation: object

serializedName

serializedName: string = "operation"

type

type: object

name

name: "String" = "String"

provider

provider: object

serializedName

serializedName: string = "provider"

type

type: object

name

name: "String" = "String"

resource

resource: object

serializedName

serializedName: string = "resource"

type

type: object

name

name: "String" = "String"

Const OperationListResponse

OperationListResponse: object
interface

An interface representing the OperationListResponse. A list of operations that can be performed by the Data Factory service.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] The link to the next page of results, if any remaining results exist.

serializedName

serializedName: string = "OperationListResponse"

__@iterator

  • Iterator

    Returns IterableIterator<Operation>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Operation>[]

      Additional items to add to the end of array1.

    Returns Operation[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Operation[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Operation]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Operation]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Operation, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Operation

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Operation[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Operation[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Operation | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns Operation | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Operation, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Operation

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Operation, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Operation

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Operation, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Operation

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns Operation | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Operation[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Operation
  • reduce(callbackfn: function, initialValue: Operation): Operation
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns Operation

  • Parameters

    Returns Operation

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Operation, currentIndex: number, array: Operation[]): U
        • Parameters

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Operation
  • reduceRight(callbackfn: function, initialValue: Operation): Operation
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns Operation

  • Parameters

    Returns Operation

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Operation, currentIndex: number, array: Operation[]): U
        • Parameters

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns Operation[]

shift

  • Removes the first element from an array and returns it.

    Returns Operation | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Operation[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Operation[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Operation[]
  • splice(start: number, deleteCount: number, ...items: Operation[]): Operation[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Operation[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Operation[]

      Elements to insert into the array in place of the deleted elements.

    Returns Operation[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Operation[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<Operation>

type

type: object

className

className: string = "OperationListResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Operation"

name

name: "Composite" = "Composite"

Const OperationLogSpecification

OperationLogSpecification: object
interface

An interface representing OperationLogSpecification. Details about an operation related to logs.

Optional blobDuration

blobDuration: undefined | string
member

{string} [blobDuration] Blobs created in the customer storage account, per hour.

Optional displayName

displayName: undefined | string
member

{string} [displayName] Localized display name.

Optional name

name: undefined | string
member

{string} [name] The name of the log category.

serializedName

serializedName: string = "OperationLogSpecification"

type

type: object

className

className: string = "OperationLogSpecification"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

blobDuration

blobDuration: object

serializedName

serializedName: string = "blobDuration"

type

type: object

name

name: "String" = "String"

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const OperationMetricAvailability

OperationMetricAvailability: object
interface

An interface representing OperationMetricAvailability. Defines how often data for a metric becomes available.

Optional blobDuration

blobDuration: undefined | string
member

{string} [blobDuration] Blob created in the customer storage account, per hour.

Optional timeGrain

timeGrain: undefined | string
member

{string} [timeGrain] The granularity for the metric.

serializedName

serializedName: string = "OperationMetricAvailability"

type

type: object

className

className: string = "OperationMetricAvailability"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

blobDuration

blobDuration: object

serializedName

serializedName: string = "blobDuration"

type

type: object

name

name: "String" = "String"

timeGrain

timeGrain: object

serializedName

serializedName: string = "timeGrain"

type

type: object

name

name: "String" = "String"

Const OperationMetricDimension

OperationMetricDimension: object
interface

An interface representing OperationMetricDimension. Defines the metric dimension.

Optional displayName

displayName: undefined | string
member

{string} [displayName] The display name of the metric dimension.

Optional name

name: undefined | string
member

{string} [name] The name of the dimension for the metric.

Optional toBeExportedForShoebox

toBeExportedForShoebox: undefined | false | true
member

{boolean} [toBeExportedForShoebox] Whether the dimension should be exported to Azure Monitor.

serializedName

serializedName: string = "OperationMetricDimension"

type

type: object

className

className: string = "OperationMetricDimension"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

toBeExportedForShoebox

toBeExportedForShoebox: object

serializedName

serializedName: string = "toBeExportedForShoebox"

type

type: object

name

name: "Boolean" = "Boolean"

Const OperationMetricSpecification

OperationMetricSpecification: object
interface

An interface representing OperationMetricSpecification. Details about an operation related to metrics.

Optional aggregationType

aggregationType: undefined | string
member

{string} [aggregationType] The type of metric aggregation.

Optional availabilities

availabilities: OperationMetricAvailability[]
member

{OperationMetricAvailability[]} [availabilities] Defines how often data for metrics becomes available.

Optional dimensions

member

{OperationMetricDimension[]} [dimensions] Defines the metric dimension.

Optional displayDescription

displayDescription: undefined | string
member

{string} [displayDescription] The description of the metric.

Optional displayName

displayName: undefined | string
member

{string} [displayName] Localized display name of the metric.

Optional enableRegionalMdmAccount

enableRegionalMdmAccount: undefined | string
member

{string} [enableRegionalMdmAccount] Whether or not the service is using regional MDM accounts.

Optional name

name: undefined | string
member

{string} [name] The name of the metric.

Optional sourceMdmAccount

sourceMdmAccount: undefined | string
member

{string} [sourceMdmAccount] The name of the MDM account.

Optional sourceMdmNamespace

sourceMdmNamespace: undefined | string
member

{string} [sourceMdmNamespace] The name of the MDM namespace.

Optional unit

unit: undefined | string
member

{string} [unit] The unit that the metric is measured in.

serializedName

serializedName: string = "OperationMetricSpecification"

type

type: object

className

className: string = "OperationMetricSpecification"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

aggregationType

aggregationType: object

serializedName

serializedName: string = "aggregationType"

type

type: object

name

name: "String" = "String"

availabilities

availabilities: object

serializedName

serializedName: string = "availabilities"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "OperationMetricAvailability"

name

name: "Composite" = "Composite"

dimensions

dimensions: object

serializedName

serializedName: string = "dimensions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "OperationMetricDimension"

name

name: "Composite" = "Composite"

displayDescription

displayDescription: object

serializedName

serializedName: string = "displayDescription"

type

type: object

name

name: "String" = "String"

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: "String" = "String"

enableRegionalMdmAccount

enableRegionalMdmAccount: object

serializedName

serializedName: string = "enableRegionalMdmAccount"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

sourceMdmAccount

sourceMdmAccount: object

serializedName

serializedName: string = "sourceMdmAccount"

type

type: object

name

name: "String" = "String"

sourceMdmNamespace

sourceMdmNamespace: object

serializedName

serializedName: string = "sourceMdmNamespace"

type

type: object

name

name: "String" = "String"

unit

unit: object

serializedName

serializedName: string = "unit"

type

type: object

name

name: "String" = "String"

Const OperationServiceSpecification

OperationServiceSpecification: object
interface

An interface representing OperationServiceSpecification. Details about a service operation.

Optional logSpecifications

logSpecifications: OperationLogSpecification[]
member

{OperationLogSpecification[]} [logSpecifications] Details about operations related to logs.

Optional metricSpecifications

metricSpecifications: OperationMetricSpecification[]
member

{OperationMetricSpecification[]} [metricSpecifications] Details about operations related to metrics.

serializedName

serializedName: string = "OperationServiceSpecification"

type

type: object

className

className: string = "OperationServiceSpecification"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

logSpecifications

logSpecifications: object

serializedName

serializedName: string = "logSpecifications"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "OperationLogSpecification"

name

name: "Composite" = "Composite"

metricSpecifications

metricSpecifications: object

serializedName

serializedName: string = "metricSpecifications"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "OperationMetricSpecification"

name

name: "Composite" = "Composite"

Const OracleLinkedService

OracleLinkedService: object
interface

An interface representing OracleLinkedService. Oracle database.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

connectionString

connectionString: any
member

{any} connectionString The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional password

member

{AzureKeyVaultSecretReference} [password] The Azure key vault secret reference of password in connection string.

serializedName

serializedName: string = "Oracle"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "OracleLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

connectionString

connectionString: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.connectionString"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

password

password: object

serializedName

serializedName: string = "typeProperties.password"

type

type: object

className

className: string = "AzureKeyVaultSecretReference"

name

name: "Composite" = "Composite"

Const OracleSink

OracleSink: object
interface

An interface representing OracleSink. A copy activity Oracle sink.

Optional preCopyScript

preCopyScript: any
member

{any} [preCopyScript] SQL pre-copy script. Type: string (or Expression with resultType string).

Optional sinkRetryCount

sinkRetryCount: any
member

{any} [sinkRetryCount] Sink retry count. Type: integer (or Expression with resultType integer).

Optional sinkRetryWait

sinkRetryWait: any
member

{any} [sinkRetryWait] Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Optional writeBatchSize

writeBatchSize: any
member

{any} [writeBatchSize] Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

Optional writeBatchTimeout

writeBatchTimeout: any
member

{any} [writeBatchTimeout] Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "OracleSink"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySink.type.additionalProperties

className

className: string = "OracleSink"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySink.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySink"

modelProperties

modelProperties: object

preCopyScript

preCopyScript: object

serializedName

serializedName: string = "preCopyScript"

type

type: object

name

name: "Object" = "Object"

Const OracleSource

OracleSource: object
interface

An interface representing OracleSource. A copy activity Oracle source.

Optional oracleReaderQuery

oracleReaderQuery: any
member

{any} [oracleReaderQuery] Oracle reader query. Type: string (or Expression with resultType string).

Optional queryTimeout

queryTimeout: any
member

{any} [queryTimeout] Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "OracleSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "OracleSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

oracleReaderQuery

oracleReaderQuery: object

serializedName

serializedName: string = "oracleReaderQuery"

type

type: object

name

name: "Object" = "Object"

queryTimeout

queryTimeout: object

serializedName

serializedName: string = "queryTimeout"

type

type: object

name

name: "Object" = "Object"

Const OracleTableDataset

OracleTableDataset: object
interface

An interface representing OracleTableDataset. The on-premises Oracle database dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

tableName

tableName: any
member

{any} tableName The table name of the on-premises Oracle database. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "OracleTable"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "OracleTableDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

tableName

tableName: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.tableName"

type

type: object

name

name: "Object" = "Object"

Const OrcFormat

OrcFormat: object
interface

An interface representing OrcFormat. The data stored in Optimized Row Columnar (ORC) format.

Optional deserializer

deserializer: any
member

{any} [deserializer] Deserializer. Type: string (or Expression with resultType string).

Optional serializer

serializer: any
member

{any} [serializer] Serializer. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "OrcFormat"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = DatasetStorageFormat.type.additionalProperties

className

className: string = "OrcFormat"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = DatasetStorageFormat.type.polymorphicDiscriminator

uberParent

uberParent: string = "DatasetStorageFormat"

modelProperties

modelProperties: object

Const ParameterSpecification

ParameterSpecification: object
interface

An interface representing ParameterSpecification. Definition of a single parameter for an entity.

Optional defaultValue

defaultValue: any
member

{any} [defaultValue] Default value of parameter.

serializedName

serializedName: string = "ParameterSpecification"

type

type: object
member

{ParameterType} type Parameter type. Possible values include: 'Object', 'String', 'Int', 'Float', 'Bool', 'Array', 'SecureString'

className

className: string = "ParameterSpecification"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

defaultValue

defaultValue: object

serializedName

serializedName: string = "defaultValue"

type

type: object

name

name: "Object" = "Object"

type

type: object

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ParquetFormat

ParquetFormat: object
interface

An interface representing ParquetFormat. The data stored in Parquet format.

Optional deserializer

deserializer: any
member

{any} [deserializer] Deserializer. Type: string (or Expression with resultType string).

Optional serializer

serializer: any
member

{any} [serializer] Serializer. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "ParquetFormat"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = DatasetStorageFormat.type.additionalProperties

className

className: string = "ParquetFormat"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = DatasetStorageFormat.type.polymorphicDiscriminator

uberParent

uberParent: string = "DatasetStorageFormat"

modelProperties

modelProperties: object

Const PaypalLinkedService

PaypalLinkedService: object
interface

An interface representing PaypalLinkedService. Paypal Serivce linked service.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

clientId

clientId: any
member

{any} clientId The client ID associated with your PayPal application.

Optional clientSecret

clientSecret: SecretBaseUnion
member

{SecretBaseUnion} [clientSecret] The client secret associated with your PayPal application.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

host

host: any
member

{any} host The URL of the PayPal instance. (i.e. api.sandbox.paypal.com)

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional useEncryptedEndpoints

useEncryptedEndpoints: any
member

{any} [useEncryptedEndpoints] Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

Optional useHostVerification

useHostVerification: any
member

{any} [useHostVerification] Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.

Optional usePeerVerification

usePeerVerification: any
member

{any} [usePeerVerification] Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

serializedName

serializedName: string = "Paypal"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "PaypalLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

clientId

clientId: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.clientId"

type

type: object

name

name: "Object" = "Object"

clientSecret

clientSecret: object

serializedName

serializedName: string = "typeProperties.clientSecret"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

host

host: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.host"

type

type: object

name

name: "Object" = "Object"

useEncryptedEndpoints

useEncryptedEndpoints: object

serializedName

serializedName: string = "typeProperties.useEncryptedEndpoints"

type

type: object

name

name: "Object" = "Object"

useHostVerification

useHostVerification: object

serializedName

serializedName: string = "typeProperties.useHostVerification"

type

type: object

name

name: "Object" = "Object"

usePeerVerification

usePeerVerification: object

serializedName

serializedName: string = "typeProperties.usePeerVerification"

type

type: object

name

name: "Object" = "Object"

Const PaypalObjectDataset

PaypalObjectDataset: object
interface

An interface representing PaypalObjectDataset. Paypal Serivce dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Optional tableName

tableName: any
member

{any} [tableName] The table name. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "PaypalObject"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "PaypalObjectDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

tableName

tableName: object

serializedName

serializedName: string = "typeProperties.tableName"

type

type: object

name

name: "Object" = "Object"

Const PaypalSource

PaypalSource: object
interface

An interface representing PaypalSource. A copy activity Paypal Serivce source.

Optional query

query: any
member

{any} [query] A query to retrieve data from source. Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "PaypalSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "PaypalSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

Const PhoenixLinkedService

PhoenixLinkedService: object
interface

An interface representing PhoenixLinkedService. Phoenix server linked service.

Optional allowHostNameCNMismatch

allowHostNameCNMismatch: any
member

{any} [allowHostNameCNMismatch] Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.

Optional allowSelfSignedServerCert

allowSelfSignedServerCert: any
member

{any} [allowSelfSignedServerCert] Specifies whether to allow self-signed certificates from the server. The default value is false.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

authenticationType

authenticationType: PhoenixAuthenticationType
member

{PhoenixAuthenticationType} authenticationType The authentication mechanism used to connect to the Phoenix server. Possible values include: 'Anonymous', 'UsernameAndPassword', 'WindowsAzureHDInsightService'

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional enableSsl

enableSsl: any
member

{any} [enableSsl] Specifies whether the connections to the server are encrypted using SSL. The default value is false.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

host

host: any
member

{any} host The IP address or host name of the Phoenix server. (i.e. 192.168.222.160)

Optional httpPath

httpPath: any
member

{any} [httpPath] The partial URL corresponding to the Phoenix server. (i.e. /gateway/sandbox/phoenix/version). The default value is hbasephoenix if using WindowsAzureHDInsightService.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional password

password: SecretBaseUnion
member

{SecretBaseUnion} [password] The password corresponding to the user name.

Optional port

port: any
member

{any} [port] The TCP port that the Phoenix server uses to listen for client connections. The default value is 8765.

Optional trustedCertPath

trustedCertPath: any
member

{any} [trustedCertPath] The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.

Optional useSystemTrustStore

useSystemTrustStore: any
member

{any} [useSystemTrustStore] Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.

Optional username

username: any
member

{any} [username] The user name used to connect to the Phoenix server.

serializedName

serializedName: string = "Phoenix"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "PhoenixLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

allowHostNameCNMismatch

allowHostNameCNMismatch: object

serializedName

serializedName: string = "typeProperties.allowHostNameCNMismatch"

type

type: object

name

name: "Object" = "Object"

allowSelfSignedServerCert

allowSelfSignedServerCert: object

serializedName

serializedName: string = "typeProperties.allowSelfSignedServerCert"

type

type: object

name

name: "Object" = "Object"

authenticationType

authenticationType: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.authenticationType"

type

type: object

name

name: "String" = "String"

enableSsl

enableSsl: object

serializedName

serializedName: string = "typeProperties.enableSsl"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

host

host: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.host"

type

type: object

name

name: "Object" = "Object"

httpPath

httpPath: object

serializedName

serializedName: string = "typeProperties.httpPath"

type

type: object

name

name: "Object" = "Object"

password

password: object

serializedName

serializedName: string = "typeProperties.password"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

port

port: object

serializedName

serializedName: string = "typeProperties.port"

type

type: object

name

name: "Object" = "Object"

trustedCertPath

trustedCertPath: object

serializedName

serializedName: string = "typeProperties.trustedCertPath"

type

type: object

name

name: "Object" = "Object"

useSystemTrustStore

useSystemTrustStore: object

serializedName

serializedName: string = "typeProperties.useSystemTrustStore"

type

type: object

name

name: "Object" = "Object"

username

username: object

serializedName

serializedName: string = "typeProperties.username"

type

type: object

name

name: "Object" = "Object"

Const PhoenixObjectDataset

PhoenixObjectDataset: object
interface

An interface representing PhoenixObjectDataset. Phoenix server dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Optional tableName

tableName: any
member

{any} [tableName] The table name. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "PhoenixObject"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "PhoenixObjectDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

tableName

tableName: object

serializedName

serializedName: string = "typeProperties.tableName"

type

type: object

name

name: "Object" = "Object"

Const PhoenixSource

PhoenixSource: object
interface

An interface representing PhoenixSource. A copy activity Phoenix server source.

Optional query

query: any
member

{any} [query] A query to retrieve data from source. Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "PhoenixSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "PhoenixSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

Const PipelineFolder

PipelineFolder: object
interface

An interface representing PipelineFolder. The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level.

Optional name

name: undefined | string
member

{string} [name] The name of the folder that this Pipeline is in.

serializedName

serializedName: string = "Pipeline_folder"

type

type: object

className

className: string = "PipelineFolder"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const PipelineListResponse

PipelineListResponse: object
interface

An interface representing the PipelineListResponse. A list of pipeline resources.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] The link to the next page of results, if any remaining results exist.

serializedName

serializedName: string = "PipelineListResponse"

__@iterator

  • Iterator

    Returns IterableIterator<PipelineResource>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<PipelineResource>[]

      Additional items to add to the end of array1.

    Returns PipelineResource[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns PipelineResource[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, PipelineResource]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: PipelineResource, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: PipelineResource

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): PipelineResource[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns PipelineResource[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): PipelineResource | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns PipelineResource | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: PipelineResource, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: PipelineResource

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: PipelineResource, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: PipelineResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: PipelineResource, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: PipelineResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns PipelineResource | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns PipelineResource

  • Parameters

    Returns PipelineResource

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns PipelineResource

  • Parameters

    Returns PipelineResource

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns PipelineResource[]

shift

  • Removes the first element from an array and returns it.

    Returns PipelineResource | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): PipelineResource[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns PipelineResource[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns PipelineResource[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: PipelineResource[]

      Elements to insert into the array in place of the deleted elements.

    Returns PipelineResource[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: PipelineResource[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<PipelineResource>

type

type: object

className

className: string = "PipelineListResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PipelineResource"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

Const PipelineReference

PipelineReference: object
interface

An interface representing PipelineReference. Pipeline reference type.

Optional name

name: undefined | string
member

{string} [name] Reference name.

referenceName

referenceName: string
member

{string} referenceName Reference pipeline name.

serializedName

serializedName: string = "PipelineReference"

type

type: object

className

className: string = "PipelineReference"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

referenceName

referenceName: object

required

required: true = true

serializedName

serializedName: string = "referenceName"

type

type: object

name

name: "String" = "String"

type

type: object

defaultValue

defaultValue: string = "PipelineReference"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const PipelineResource

PipelineResource: object
interface

An interface representing PipelineResource. Pipeline resource type.

extends

SubResource

Optional activities

activities: ActivityUnion[]
member

{ActivityUnion[]} [activities] List of activities in pipeline.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Pipeline.

Optional concurrency

concurrency: undefined | number
member

{number} [concurrency] The max number of concurrent runs for the pipeline.

Optional description

description: undefined | string
member

{string} [description] The description of the pipeline.

Optional etag

etag: undefined | string
member

{string} [etag] Etag identifies change in the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional folder

member

{PipelineFolder} [folder] The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level.

Optional id

id: undefined | string
member

{string} [id] The resource identifier. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string
member

{string} [name] The resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] List of parameters for pipeline.

Optional variables

variables: undefined | object
member

{{ [propertyName: string]: VariableSpecification }} [variables] List of variables for pipeline.

serializedName

serializedName: string = "PipelineResource"

Optional type

type: object
member

{string} [type] The resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "PipelineResource"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

modelProperties

modelProperties: object

activities

activities: object

serializedName

serializedName: string = "properties.activities"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Activity"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

annotations

annotations: object

serializedName

serializedName: string = "properties.annotations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "Object" = "Object"

concurrency

concurrency: object

serializedName

serializedName: string = "properties.concurrency"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

folder

folder: object

serializedName

serializedName: string = "properties.folder"

type

type: object

className

className: string = "PipelineFolder"

name

name: "Composite" = "Composite"

parameters

parameters: object

serializedName

serializedName: string = "properties.parameters"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

className

className: string = "ParameterSpecification"

name

name: "Composite" = "Composite"

variables

variables: object

serializedName

serializedName: string = "properties.variables"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

className

className: string = "VariableSpecification"

name

name: "Composite" = "Composite"

Const PipelineRun

PipelineRun: object
interface

An interface representing PipelineRun. Information about a pipeline run.

Optional durationInMs

durationInMs: undefined | number
member

{number} [durationInMs] The duration of a pipeline run. NOTE: This property will not be serialized. It can only be populated by the server.

Optional invokedBy

member

{PipelineRunInvokedBy} [invokedBy] Entity that started the pipeline run. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastUpdated

lastUpdated: Date
member

{Date} [lastUpdated] The last updated timestamp for the pipeline run event in ISO8601 format. NOTE: This property will not be serialized. It can only be populated by the server.

Optional message

message: undefined | string
member

{string} [message] The message from a pipeline run. NOTE: This property will not be serialized. It can only be populated by the server.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: string }} [parameters] The full or partial list of parameter name, value pair used in the pipeline run. NOTE: This property will not be serialized. It can only be populated by the server.

Optional pipelineName

pipelineName: undefined | string
member

{string} [pipelineName] The pipeline name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional runEnd

runEnd: Date
member

{Date} [runEnd] The end time of a pipeline run in ISO8601 format. NOTE: This property will not be serialized. It can only be populated by the server.

Optional runId

runId: undefined | string
member

{string} [runId] Identifier of a run. NOTE: This property will not be serialized. It can only be populated by the server.

Optional runStart

runStart: Date
member

{Date} [runStart] The start time of a pipeline run in ISO8601 format. NOTE: This property will not be serialized. It can only be populated by the server.

Optional status

status: undefined | string
member

{string} [status] The status of a pipeline run. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "PipelineRun"

type

type: object

className

className: string = "PipelineRun"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

modelProperties

modelProperties: object

durationInMs

durationInMs: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "durationInMs"

type

type: object

name

name: "Number" = "Number"

invokedBy

invokedBy: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "invokedBy"

type

type: object

className

className: string = "PipelineRunInvokedBy"

name

name: "Composite" = "Composite"

lastUpdated

lastUpdated: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "lastUpdated"

type

type: object

name

name: "DateTime" = "DateTime"

message

message: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

parameters

parameters: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "parameters"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

pipelineName

pipelineName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "pipelineName"

type

type: object

name

name: "String" = "String"

runEnd

runEnd: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "runEnd"

type

type: object

name

name: "DateTime" = "DateTime"

runId

runId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "runId"

type

type: object

name

name: "String" = "String"

runStart

runStart: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "runStart"

type

type: object

name

name: "DateTime" = "DateTime"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

Const PipelineRunInvokedBy

PipelineRunInvokedBy: object
interface

An interface representing PipelineRunInvokedBy. Provides entity name and id that started the pipeline run.

Optional id

id: undefined | string
member

{string} [id] The ID of the entity that started the run. NOTE: This property will not be serialized. It can only be populated by the server.

Optional invokedByType

invokedByType: undefined | string
member

{string} [invokedByType] The type of the entity that started the run. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string
member

{string} [name] Name of the entity that started the pipeline run. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "PipelineRunInvokedBy"

type

type: object

className

className: string = "PipelineRunInvokedBy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

invokedByType

invokedByType: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "invokedByType"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const PipelineRunsQueryResponse

PipelineRunsQueryResponse: object
interface

An interface representing PipelineRunsQueryResponse. A list pipeline runs.

Optional continuationToken

continuationToken: undefined | string
member

{string} [continuationToken] The continuation token for getting the next page of results, if any remaining results exist, null otherwise.

value

value: PipelineRun[]
member

{PipelineRun[]} value List of pipeline runs.

serializedName

serializedName: string = "PipelineRunsQueryResponse"

type

type: object

className

className: string = "PipelineRunsQueryResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

continuationToken

continuationToken: object

serializedName

serializedName: string = "continuationToken"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PipelineRun"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

Const PolybaseSettings

PolybaseSettings: object
interface

An interface representing PolybaseSettings. PolyBase settings.

Optional rejectSampleValue

rejectSampleValue: any
member

{any} [rejectSampleValue] Determines the number of rows to attempt to retrieve before the PolyBase recalculates the percentage of rejected rows. Type: integer (or Expression with resultType integer), minimum: 0.

Optional rejectType

member

{PolybaseSettingsRejectType} [rejectType] Reject type. Possible values include: 'value', 'percentage'

Optional rejectValue

rejectValue: any
member

{any} [rejectValue] Specifies the value or the percentage of rows that can be rejected before the query fails. Type: number (or Expression with resultType number), minimum: 0.

Optional useTypeDefault

useTypeDefault: any
member

{any} [useTypeDefault] Specifies how to handle missing values in delimited text files when PolyBase retrieves data from the text file. Type: boolean (or Expression with resultType boolean).

serializedName

serializedName: string = "PolybaseSettings"

type

type: object

className

className: string = "PolybaseSettings"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

modelProperties

modelProperties: object

rejectSampleValue

rejectSampleValue: object

serializedName

serializedName: string = "rejectSampleValue"

type

type: object

name

name: "Object" = "Object"

rejectType

rejectType: object

serializedName

serializedName: string = "rejectType"

type

type: object

name

name: "String" = "String"

rejectValue

rejectValue: object

serializedName

serializedName: string = "rejectValue"

type

type: object

name

name: "Object" = "Object"

useTypeDefault

useTypeDefault: object

serializedName

serializedName: string = "useTypeDefault"

type

type: object

name

name: "Object" = "Object"

Const PostgreSqlLinkedService

PostgreSqlLinkedService: object
interface

An interface representing PostgreSqlLinkedService. Linked service for PostgreSQL data source.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

connectionString

connectionString: SecretBaseUnion
member

{SecretBaseUnion} connectionString The connection string.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional password

member

{AzureKeyVaultSecretReference} [password] The Azure key vault secret reference of password in connection string.

serializedName

serializedName: string = "PostgreSql"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "PostgreSqlLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

connectionString

connectionString: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.connectionString"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

password

password: object

serializedName

serializedName: string = "typeProperties.password"

type

type: object

className

className: string = "AzureKeyVaultSecretReference"

name

name: "Composite" = "Composite"

Const PrestoLinkedService

PrestoLinkedService: object
interface

An interface representing PrestoLinkedService. Presto server linked service.

Optional allowHostNameCNMismatch

allowHostNameCNMismatch: any
member

{any} [allowHostNameCNMismatch] Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.

Optional allowSelfSignedServerCert

allowSelfSignedServerCert: any
member

{any} [allowSelfSignedServerCert] Specifies whether to allow self-signed certificates from the server. The default value is false.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

authenticationType

authenticationType: PrestoAuthenticationType
member

{PrestoAuthenticationType} authenticationType The authentication mechanism used to connect to the Presto server. Possible values include: 'Anonymous', 'LDAP'

catalog

catalog: any
member

{any} catalog The catalog context for all request against the server.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional enableSsl

enableSsl: any
member

{any} [enableSsl] Specifies whether the connections to the server are encrypted using SSL. The default value is false.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

host

host: any
member

{any} host The IP address or host name of the Presto server. (i.e. 192.168.222.160)

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional password

password: SecretBaseUnion
member

{SecretBaseUnion} [password] The password corresponding to the user name.

Optional port

port: any
member

{any} [port] The TCP port that the Presto server uses to listen for client connections. The default value is 8080.

serverVersion

serverVersion: any
member

{any} serverVersion The version of the Presto server. (i.e. 0.148-t)

Optional timeZoneID

timeZoneID: any
member

{any} [timeZoneID] The local time zone used by the connection. Valid values for this option are specified in the IANA Time Zone Database. The default value is the system time zone.

Optional trustedCertPath

trustedCertPath: any
member

{any} [trustedCertPath] The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.

Optional useSystemTrustStore

useSystemTrustStore: any
member

{any} [useSystemTrustStore] Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.

Optional username

username: any
member

{any} [username] The user name used to connect to the Presto server.

serializedName

serializedName: string = "Presto"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "PrestoLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

allowHostNameCNMismatch

allowHostNameCNMismatch: object

serializedName

serializedName: string = "typeProperties.allowHostNameCNMismatch"

type

type: object

name

name: "Object" = "Object"

allowSelfSignedServerCert

allowSelfSignedServerCert: object

serializedName

serializedName: string = "typeProperties.allowSelfSignedServerCert"

type

type: object

name

name: "Object" = "Object"

authenticationType

authenticationType: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.authenticationType"

type

type: object

name

name: "String" = "String"

catalog

catalog: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.catalog"

type

type: object

name

name: "Object" = "Object"

enableSsl

enableSsl: object

serializedName

serializedName: string = "typeProperties.enableSsl"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

host

host: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.host"

type

type: object

name

name: "Object" = "Object"

password

password: object

serializedName

serializedName: string = "typeProperties.password"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

port

port: object

serializedName

serializedName: string = "typeProperties.port"

type

type: object

name

name: "Object" = "Object"

serverVersion

serverVersion: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.serverVersion"

type

type: object

name

name: "Object" = "Object"

timeZoneID

timeZoneID: object

serializedName

serializedName: string = "typeProperties.timeZoneID"

type

type: object

name

name: "Object" = "Object"

trustedCertPath

trustedCertPath: object

serializedName

serializedName: string = "typeProperties.trustedCertPath"

type

type: object

name

name: "Object" = "Object"

useSystemTrustStore

useSystemTrustStore: object

serializedName

serializedName: string = "typeProperties.useSystemTrustStore"

type

type: object

name

name: "Object" = "Object"

username

username: object

serializedName

serializedName: string = "typeProperties.username"

type

type: object

name

name: "Object" = "Object"

Const PrestoObjectDataset

PrestoObjectDataset: object
interface

An interface representing PrestoObjectDataset. Presto server dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Optional tableName

tableName: any
member

{any} [tableName] The table name. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "PrestoObject"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "PrestoObjectDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

tableName

tableName: object

serializedName

serializedName: string = "typeProperties.tableName"

type

type: object

name

name: "Object" = "Object"

Const PrestoSource

PrestoSource: object
interface

An interface representing PrestoSource. A copy activity Presto server source.

Optional query

query: any
member

{any} [query] A query to retrieve data from source. Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "PrestoSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "PrestoSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

Const QuickBooksLinkedService

QuickBooksLinkedService: object
interface

An interface representing QuickBooksLinkedService. QuickBooks server linked service.

accessToken

accessToken: SecretBaseUnion
member

{SecretBaseUnion} accessToken The access token for OAuth 1.0 authentication.

accessTokenSecret

accessTokenSecret: SecretBaseUnion
member

{SecretBaseUnion} accessTokenSecret The access token secret for OAuth 1.0 authentication.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

companyId

companyId: any
member

{any} companyId The company ID of the QuickBooks company to authorize.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

consumerKey

consumerKey: any
member

{any} consumerKey The consumer key for OAuth 1.0 authentication.

consumerSecret

consumerSecret: SecretBaseUnion
member

{SecretBaseUnion} consumerSecret The consumer secret for OAuth 1.0 authentication.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

endpoint

endpoint: any
member

{any} endpoint The endpoint of the QuickBooks server. (i.e. quickbooks.api.intuit.com)

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional useEncryptedEndpoints

useEncryptedEndpoints: any
member

{any} [useEncryptedEndpoints] Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

serializedName

serializedName: string = "QuickBooks"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "QuickBooksLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

accessToken

accessToken: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.accessToken"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

accessTokenSecret

accessTokenSecret: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.accessTokenSecret"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

companyId

companyId: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.companyId"

type

type: object

name

name: "Object" = "Object"

consumerKey

consumerKey: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.consumerKey"

type

type: object

name

name: "Object" = "Object"

consumerSecret

consumerSecret: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.consumerSecret"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

endpoint

endpoint: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.endpoint"

type

type: object

name

name: "Object" = "Object"

useEncryptedEndpoints

useEncryptedEndpoints: object

serializedName

serializedName: string = "typeProperties.useEncryptedEndpoints"

type

type: object

name

name: "Object" = "Object"

Const QuickBooksObjectDataset

QuickBooksObjectDataset: object
interface

An interface representing QuickBooksObjectDataset. QuickBooks server dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Optional tableName

tableName: any
member

{any} [tableName] The table name. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "QuickBooksObject"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "QuickBooksObjectDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

tableName

tableName: object

serializedName

serializedName: string = "typeProperties.tableName"

type

type: object

name

name: "Object" = "Object"

Const QuickBooksSource

QuickBooksSource: object
interface

An interface representing QuickBooksSource. A copy activity QuickBooks server source.

Optional query

query: any
member

{any} [query] A query to retrieve data from source. Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "QuickBooksSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "QuickBooksSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

Const RecurrenceSchedule

RecurrenceSchedule: object
interface

An interface representing RecurrenceSchedule. The recurrence schedule.

Optional hours

hours: number[]
member

{number[]} [hours] The hours.

Optional minutes

minutes: number[]
member

{number[]} [minutes] The minutes.

Optional monthDays

monthDays: number[]
member

{number[]} [monthDays] The month days.

Optional monthlyOccurrences

monthlyOccurrences: RecurrenceScheduleOccurrence[]
member

{RecurrenceScheduleOccurrence[]} [monthlyOccurrences] The monthly occurrences.

Optional weekDays

weekDays: DaysOfWeek[]
member

{DaysOfWeek[]} [weekDays] The days of the week.

serializedName

serializedName: string = "RecurrenceSchedule"

type

type: object

className

className: string = "RecurrenceSchedule"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

modelProperties

modelProperties: object

hours

hours: object

serializedName

serializedName: string = "hours"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "Number" = "Number"

minutes

minutes: object

serializedName

serializedName: string = "minutes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "Number" = "Number"

monthDays

monthDays: object

serializedName

serializedName: string = "monthDays"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "Number" = "Number"

monthlyOccurrences

monthlyOccurrences: object

serializedName

serializedName: string = "monthlyOccurrences"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RecurrenceScheduleOccurrence"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

weekDays

weekDays: object

serializedName

serializedName: string = "weekDays"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]

name

name: "Enum" = "Enum"

Const RecurrenceScheduleOccurrence

RecurrenceScheduleOccurrence: object
interface

An interface representing RecurrenceScheduleOccurrence. The recurrence schedule occurence.

Optional day

member

{DayOfWeek} [day] The day of the week. Possible values include: 'Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'

Optional occurrence

occurrence: undefined | number
member

{number} [occurrence] The occurrence.

serializedName

serializedName: string = "RecurrenceScheduleOccurrence"

type

type: object

className

className: string = "RecurrenceScheduleOccurrence"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

modelProperties

modelProperties: object

day

day: object

serializedName

serializedName: string = "day"

type

type: object

allowedValues

allowedValues: string[] = ["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]

name

name: "Enum" = "Enum"

occurrence

occurrence: object

serializedName

serializedName: string = "occurrence"

type

type: object

name

name: "Number" = "Number"

Const RedirectIncompatibleRowSettings

RedirectIncompatibleRowSettings: object
interface

An interface representing RedirectIncompatibleRowSettings. Redirect incompatible row settings

linkedServiceName

linkedServiceName: any
member

{any} linkedServiceName Name of the Azure Storage, Storage SAS, or Azure Data Lake Store linked service used for redirecting incompatible row. Must be specified if redirectIncompatibleRowSettings is specified. Type: string (or Expression with resultType string).

Optional path

path: any
member

{any} [path] The path for storing the redirect incompatible row data. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "RedirectIncompatibleRowSettings"

type

type: object

className

className: string = "RedirectIncompatibleRowSettings"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

modelProperties

modelProperties: object

linkedServiceName

linkedServiceName: object

required

required: true = true

serializedName

serializedName: string = "linkedServiceName"

type

type: object

name

name: "Object" = "Object"

path

path: object

serializedName

serializedName: string = "path"

type

type: object

name

name: "Object" = "Object"

Const RedshiftUnloadSettings

RedshiftUnloadSettings: object
interface

An interface representing RedshiftUnloadSettings. The Amazon S3 settings needed for the interim Amazon S3 when copying from Amazon Redshift with unload. With this, data from Amazon Redshift source will be unloaded into S3 first and then copied into the targeted sink from the interim S3.

bucketName

bucketName: any
member

{any} bucketName The bucket of the interim Amazon S3 which will be used to store the unloaded data from Amazon Redshift source. The bucket must be in the same region as the Amazon Redshift source. Type: string (or Expression with resultType string).

s3LinkedServiceName

s3LinkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} s3LinkedServiceName The name of the Amazon S3 linked service which will be used for the unload operation when copying from the Amazon Redshift source.

serializedName

serializedName: string = "RedshiftUnloadSettings"

type

type: object

className

className: string = "RedshiftUnloadSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

bucketName

bucketName: object

required

required: true = true

serializedName

serializedName: string = "bucketName"

type

type: object

name

name: "Object" = "Object"

s3LinkedServiceName

s3LinkedServiceName: object

defaultValue

defaultValue: object

Type declaration

required

required: true = true

serializedName

serializedName: string = "s3LinkedServiceName"

type

type: object

className

className: string = "LinkedServiceReference"

name

name: "Composite" = "Composite"

Const RelationalSource

RelationalSource: object
interface

An interface representing RelationalSource. A copy activity source for various relational databases.

Optional query

query: any
member

{any} [query] Database query. Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "RelationalSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "RelationalSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

Const RelationalTableDataset

RelationalTableDataset: object
interface

An interface representing RelationalTableDataset. The relational table dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Optional tableName

tableName: any
member

{any} [tableName] The relational table name. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "RelationalTable"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "RelationalTableDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

tableName

tableName: object

serializedName

serializedName: string = "typeProperties.tableName"

type

type: object

name

name: "Object" = "Object"

Const RerunTriggerListResponse

RerunTriggerListResponse: object
interface

An interface representing the RerunTriggerListResponse. A list of rerun triggers.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] The continuation token for getting the next page of results, if any remaining results exist, null otherwise. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "RerunTriggerListResponse"

__@iterator

  • Iterator

    Returns IterableIterator<RerunTriggerResource>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns RerunTriggerResource[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns RerunTriggerResource[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, RerunTriggerResource]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: RerunTriggerResource

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): RerunTriggerResource[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns RerunTriggerResource[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): RerunTriggerResource | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns RerunTriggerResource | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: RerunTriggerResource

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: RerunTriggerResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: RerunTriggerResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns RerunTriggerResource | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns RerunTriggerResource

  • Parameters

    Returns RerunTriggerResource

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns RerunTriggerResource

  • Parameters

    Returns RerunTriggerResource

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns RerunTriggerResource[]

shift

  • Removes the first element from an array and returns it.

    Returns RerunTriggerResource | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns RerunTriggerResource[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns RerunTriggerResource[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: RerunTriggerResource[]

      Elements to insert into the array in place of the deleted elements.

    Returns RerunTriggerResource[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<RerunTriggerResource>

type

type: object

className

className: string = "RerunTriggerListResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RerunTriggerResource"

name

name: "Composite" = "Composite"

Const RerunTriggerResource

RerunTriggerResource: object
interface

An interface representing RerunTriggerResource. RerunTrigger resource type.

extends

SubResource

Optional etag

etag: undefined | string
member

{string} [etag] Etag identifies change in the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string
member

{string} [id] The resource identifier. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string
member

{string} [name] The resource name. NOTE: This property will not be serialized. It can only be populated by the server.

properties

member

{RerunTumblingWindowTrigger} properties Properties of the rerun trigger.

serializedName

serializedName: string = "RerunTriggerResource"

Optional type

type: object
member

{string} [type] The resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "RerunTriggerResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

required

required: true = true

serializedName

serializedName: string = "properties"

type

type: object

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Trigger.type.additionalProperties

className

className: string = "RerunTumblingWindowTrigger"

name

name: "Composite" = "Composite"

Const RerunTumblingWindowTrigger

RerunTumblingWindowTrigger: object
interface

An interface representing RerunTumblingWindowTrigger. Trigger that schedules pipeline reruns for all fixed time interval windows from a requested start time to requested end time.

Optional description

description: undefined | string
member

{string} [description] Trigger description.

maxConcurrency

maxConcurrency: number
member

{number} maxConcurrency The max number of parallel time windows (ready for execution) for which a rerun is triggered.

Optional parentTrigger

parentTrigger: any
member

{any} [parentTrigger] The parent trigger reference.

requestedEndTime

requestedEndTime: Date
member

{Date} requestedEndTime The end time for the time period for which restatement is initiated. Only UTC time is currently supported.

requestedStartTime

requestedStartTime: Date
member

{Date} requestedStartTime The start time for the time period for which restatement is initiated. Only UTC time is currently supported.

Optional runtimeState

runtimeState: TriggerRuntimeState
member

{TriggerRuntimeState} [runtimeState] Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. Possible values include: 'Started', 'Stopped', 'Disabled' NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "RerunTumblingWindowTrigger"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Trigger.type.additionalProperties

className

className: string = "RerunTumblingWindowTrigger"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Trigger.type.polymorphicDiscriminator

uberParent

uberParent: string = "Trigger"

modelProperties

modelProperties: object

maxConcurrency

maxConcurrency: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.maxConcurrency"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 50

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

parentTrigger

parentTrigger: object

serializedName

serializedName: string = "typeProperties.parentTrigger"

type

type: object

name

name: "Object" = "Object"

requestedEndTime

requestedEndTime: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.requestedEndTime"

type

type: object

name

name: "DateTime" = "DateTime"

requestedStartTime

requestedStartTime: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.requestedStartTime"

type

type: object

name

name: "DateTime" = "DateTime"

Const RerunTumblingWindowTriggerActionParameters

RerunTumblingWindowTriggerActionParameters: object
interface

An interface representing RerunTumblingWindowTriggerActionParameters. Rerun tumbling window trigger Parameters.

endTime

endTime: Date
member

{Date} endTime The end time for the time period for which restatement is initiated. Only UTC time is currently supported.

maxConcurrency

maxConcurrency: number
member

{number} maxConcurrency The max number of parallel time windows (ready for execution) for which a rerun is triggered.

startTime

startTime: Date
member

{Date} startTime The start time for the time period for which restatement is initiated. Only UTC time is currently supported.

serializedName

serializedName: string = "RerunTumblingWindowTriggerActionParameters"

type

type: object

className

className: string = "RerunTumblingWindowTriggerActionParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

endTime

endTime: object

required

required: true = true

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

maxConcurrency

maxConcurrency: object

required

required: true = true

serializedName

serializedName: string = "maxConcurrency"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 50

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

startTime

startTime: object

required

required: true = true

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

Const Resource

Resource: object
interface

An interface representing Resource. Azure Data Factory top-level resource.

extends

BaseResource

Optional eTag

eTag: undefined | string
member

{string} [eTag] Etag identifies change in the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string
member

{string} [id] The resource identifier. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] The resource location.

Optional name

name: undefined | string
member

{string} [name] The resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] The resource tags.

serializedName

serializedName: string = "Resource"

Optional type

type: object
member

{string} [type] The resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Resource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "eTag"

type

type: object

name

name: "String" = "String"

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ResponsysLinkedService

ResponsysLinkedService: object
interface

An interface representing ResponsysLinkedService. Responsys linked service.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

clientId

clientId: any
member

{any} clientId The client ID associated with the Responsys application. Type: string (or Expression with resultType string).

Optional clientSecret

clientSecret: SecretBaseUnion
member

{SecretBaseUnion} [clientSecret] The client secret associated with the Responsys application. Type: string (or Expression with resultType string).

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

endpoint

endpoint: any
member

{any} endpoint The endpoint of the Responsys server.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional useEncryptedEndpoints

useEncryptedEndpoints: any
member

{any} [useEncryptedEndpoints] Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).

Optional useHostVerification

useHostVerification: any
member

{any} [useHostVerification] Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).

Optional usePeerVerification

usePeerVerification: any
member

{any} [usePeerVerification] Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).

serializedName

serializedName: string = "Responsys"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "ResponsysLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

clientId

clientId: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.clientId"

type

type: object

name

name: "Object" = "Object"

clientSecret

clientSecret: object

serializedName

serializedName: string = "typeProperties.clientSecret"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

endpoint

endpoint: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.endpoint"

type

type: object

name

name: "Object" = "Object"

useEncryptedEndpoints

useEncryptedEndpoints: object

serializedName

serializedName: string = "typeProperties.useEncryptedEndpoints"

type

type: object

name

name: "Object" = "Object"

useHostVerification

useHostVerification: object

serializedName

serializedName: string = "typeProperties.useHostVerification"

type

type: object

name

name: "Object" = "Object"

usePeerVerification

usePeerVerification: object

serializedName

serializedName: string = "typeProperties.usePeerVerification"

type

type: object

name

name: "Object" = "Object"

Const ResponsysObjectDataset

ResponsysObjectDataset: object
interface

An interface representing ResponsysObjectDataset. Responsys dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Optional tableName

tableName: any
member

{any} [tableName] The table name. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "ResponsysObject"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "ResponsysObjectDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

tableName

tableName: object

serializedName

serializedName: string = "typeProperties.tableName"

type

type: object

name

name: "Object" = "Object"

Const ResponsysSource

ResponsysSource: object
interface

An interface representing ResponsysSource. A copy activity Responsys source.

Optional query

query: any
member

{any} [query] A query to retrieve data from source. Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "ResponsysSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "ResponsysSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

Const RetryPolicy

RetryPolicy: object
interface

An interface representing RetryPolicy. Execution policy for an activity.

Optional count

count: any
member

{any} [count] Maximum ordinary retry attempts. Default is 0. Type: integer (or Expression with resultType integer), minimum: 0.

Optional intervalInSeconds

intervalInSeconds: undefined | number
member

{number} [intervalInSeconds] Interval between retries in seconds. Default is 30.

serializedName

serializedName: string = "RetryPolicy"

type

type: object

className

className: string = "RetryPolicy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

count

count: object

serializedName

serializedName: string = "count"

type

type: object

name

name: "Object" = "Object"

intervalInSeconds

intervalInSeconds: object

serializedName

serializedName: string = "intervalInSeconds"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 86400

InclusiveMinimum

InclusiveMinimum: number = 30

type

type: object

name

name: "Number" = "Number"

Const RunFilterParameters

RunFilterParameters: object
interface

An interface representing RunFilterParameters. Query parameters for listing runs.

Optional continuationToken

continuationToken: undefined | string
member

{string} [continuationToken] The continuation token for getting the next page of results. Null for first page.

Optional filters

filters: RunQueryFilter[]
member

{RunQueryFilter[]} [filters] List of filters.

lastUpdatedAfter

lastUpdatedAfter: Date
member

{Date} lastUpdatedAfter The time at or after which the run event was updated in 'ISO 8601' format.

lastUpdatedBefore

lastUpdatedBefore: Date
member

{Date} lastUpdatedBefore The time at or before which the run event was updated in 'ISO 8601' format.

Optional orderBy

orderBy: RunQueryOrderBy[]
member

{RunQueryOrderBy[]} [orderBy] List of OrderBy option.

serializedName

serializedName: string = "RunFilterParameters"

type

type: object

className

className: string = "RunFilterParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

continuationToken

continuationToken: object

serializedName

serializedName: string = "continuationToken"

type

type: object

name

name: "String" = "String"

filters

filters: object

serializedName

serializedName: string = "filters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RunQueryFilter"

name

name: "Composite" = "Composite"

lastUpdatedAfter

lastUpdatedAfter: object

required

required: true = true

serializedName

serializedName: string = "lastUpdatedAfter"

type

type: object

name

name: "DateTime" = "DateTime"

lastUpdatedBefore

lastUpdatedBefore: object

required

required: true = true

serializedName

serializedName: string = "lastUpdatedBefore"

type

type: object

name

name: "DateTime" = "DateTime"

orderBy

orderBy: object

serializedName

serializedName: string = "orderBy"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RunQueryOrderBy"

name

name: "Composite" = "Composite"

Const RunQueryFilter

RunQueryFilter: object
interface

An interface representing RunQueryFilter. Query filter option for listing runs.

operand

member

{RunQueryFilterOperand} operand Parameter name to be used for filter. The allowed operands to query pipeline runs are PipelineName, RunStart, RunEnd and Status; to query activity runs are ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType and Status, and to query trigger runs are TriggerName, TriggerRunTimestamp and Status. Possible values include: 'PipelineName', 'Status', 'RunStart', 'RunEnd', 'ActivityName', 'ActivityRunStart', 'ActivityRunEnd', 'ActivityType', 'TriggerName', 'TriggerRunTimestamp'

operator

member

{RunQueryFilterOperator} operator Operator to be used for filter. Possible values include: 'Equals', 'NotEquals', 'In', 'NotIn'

values

values: string[]
member

{string[]} values List of filter values.

serializedName

serializedName: string = "RunQueryFilter"

type

type: object

className

className: string = "RunQueryFilter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

operand

operand: object

required

required: true = true

serializedName

serializedName: string = "operand"

type

type: object

name

name: "String" = "String"

operator

operator: object

required

required: true = true

serializedName

serializedName: string = "operator"

type

type: object

name

name: "String" = "String"

values

values: object

required

required: true = true

serializedName

serializedName: string = "values"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const RunQueryOrderBy

RunQueryOrderBy: object
interface

An interface representing RunQueryOrderBy. An object to provide order by options for listing runs.

order

member

{RunQueryOrder} order Sorting order of the parameter. Possible values include: 'ASC', 'DESC'

orderBy

member

{RunQueryOrderByField} orderBy Parameter name to be used for order by. The allowed parameters to order by for pipeline runs are PipelineName, RunStart, RunEnd and Status; for activity runs are ActivityName, ActivityRunStart, ActivityRunEnd and Status; for trigger runs are TriggerName, TriggerRunTimestamp and Status. Possible values include: 'RunStart', 'RunEnd', 'PipelineName', 'Status', 'ActivityName', 'ActivityRunStart', 'ActivityRunEnd', 'TriggerName', 'TriggerRunTimestamp'

serializedName

serializedName: string = "RunQueryOrderBy"

type

type: object

className

className: string = "RunQueryOrderBy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

order

order: object

required

required: true = true

serializedName

serializedName: string = "order"

type

type: object

name

name: "String" = "String"

orderBy

orderBy: object

required

required: true = true

serializedName

serializedName: string = "orderBy"

type

type: object

name

name: "String" = "String"

Const SSISExecutionParameter

SSISExecutionParameter: object
interface

An interface representing SSISExecutionParameter. SSIS execution parameter.

value

value: any
member

{any} value SSIS package execution parameter value. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "SSISExecutionParameter"

type

type: object

className

className: string = "SSISExecutionParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

required

required: true = true

serializedName

serializedName: string = "value"

type

type: object

name

name: "Object" = "Object"

Const SSISPackageLocation

SSISPackageLocation: object
interface

An interface representing SSISPackageLocation. SSIS package location.

packagePath

packagePath: string
member

{string} packagePath The SSIS package path.

serializedName

serializedName: string = "SSISPackageLocation"

type

type: object

className

className: string = "SSISPackageLocation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

packagePath

packagePath: object

required

required: true = true

serializedName

serializedName: string = "packagePath"

type

type: object

name

name: "String" = "String"

Const SSISPropertyOverride

SSISPropertyOverride: object
interface

An interface representing SSISPropertyOverride. SSIS property override.

Optional isSensitive

isSensitive: undefined | false | true
member

{boolean} [isSensitive] Whether SSIS package property override value is sensitive data. Value will be encrypted in SSISDB if it is true

value

value: any
member

{any} value SSIS package property override value. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "SSISPropertyOverride"

type

type: object

className

className: string = "SSISPropertyOverride"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

isSensitive

isSensitive: object

serializedName

serializedName: string = "isSensitive"

type

type: object

name

name: "Boolean" = "Boolean"

value

value: object

required

required: true = true

serializedName

serializedName: string = "value"

type

type: object

name

name: "Object" = "Object"

Const SalesforceLinkedService

SalesforceLinkedService: object
interface

An interface representing SalesforceLinkedService. Linked service for Salesforce.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional environmentUrl

environmentUrl: any
member

{any} [environmentUrl] The URL of Salesforce instance. Default is 'https://login.salesforce.com'. To copy data from sandbox, specify 'https://test.salesforce.com'. To copy data from custom domain, specify, for example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional password

password: SecretBaseUnion
member

{SecretBaseUnion} [password] The password for Basic authentication of the Salesforce instance.

Optional securityToken

securityToken: SecretBaseUnion
member

{SecretBaseUnion} [securityToken] The security token is required to remotely access Salesforce instance.

Optional username

username: any
member

{any} [username] The username for Basic authentication of the Salesforce instance. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "Salesforce"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "SalesforceLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

environmentUrl

environmentUrl: object

serializedName

serializedName: string = "typeProperties.environmentUrl"

type

type: object

name

name: "Object" = "Object"

password

password: object

serializedName

serializedName: string = "typeProperties.password"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

securityToken

securityToken: object

serializedName

serializedName: string = "typeProperties.securityToken"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

username

username: object

serializedName

serializedName: string = "typeProperties.username"

type

type: object

name

name: "Object" = "Object"

Const SalesforceMarketingCloudLinkedService

SalesforceMarketingCloudLinkedService: object
interface

An interface representing SalesforceMarketingCloudLinkedService. Salesforce Marketing Cloud linked service.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

clientId

clientId: any
member

{any} clientId The client ID associated with the Salesforce Marketing Cloud application. Type: string (or Expression with resultType string).

Optional clientSecret

clientSecret: SecretBaseUnion
member

{SecretBaseUnion} [clientSecret] The client secret associated with the Salesforce Marketing Cloud application. Type: string (or Expression with resultType string).

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional useEncryptedEndpoints

useEncryptedEndpoints: any
member

{any} [useEncryptedEndpoints] Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).

Optional useHostVerification

useHostVerification: any
member

{any} [useHostVerification] Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).

Optional usePeerVerification

usePeerVerification: any
member

{any} [usePeerVerification] Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).

serializedName

serializedName: string = "SalesforceMarketingCloud"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "SalesforceMarketingCloudLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

clientId

clientId: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.clientId"

type

type: object

name

name: "Object" = "Object"

clientSecret

clientSecret: object

serializedName

serializedName: string = "typeProperties.clientSecret"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

useEncryptedEndpoints

useEncryptedEndpoints: object

serializedName

serializedName: string = "typeProperties.useEncryptedEndpoints"

type

type: object

name

name: "Object" = "Object"

useHostVerification

useHostVerification: object

serializedName

serializedName: string = "typeProperties.useHostVerification"

type

type: object

name

name: "Object" = "Object"

usePeerVerification

usePeerVerification: object

serializedName

serializedName: string = "typeProperties.usePeerVerification"

type

type: object

name

name: "Object" = "Object"

Const SalesforceMarketingCloudObjectDataset

SalesforceMarketingCloudObjectDataset: object
interface

An interface representing SalesforceMarketingCloudObjectDataset. Salesforce Marketing Cloud dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Optional tableName

tableName: any
member

{any} [tableName] The table name. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "SalesforceMarketingCloudObject"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "SalesforceMarketingCloudObjectDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

tableName

tableName: object

serializedName

serializedName: string = "typeProperties.tableName"

type

type: object

name

name: "Object" = "Object"

Const SalesforceMarketingCloudSource

SalesforceMarketingCloudSource: object
interface

An interface representing SalesforceMarketingCloudSource. A copy activity Salesforce Marketing Cloud source.

Optional query

query: any
member

{any} [query] A query to retrieve data from source. Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "SalesforceMarketingCloudSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "SalesforceMarketingCloudSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

Const SalesforceObjectDataset

SalesforceObjectDataset: object
interface

An interface representing SalesforceObjectDataset. The Salesforce object dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional objectApiName

objectApiName: any
member

{any} [objectApiName] The Salesforce object API name. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

serializedName

serializedName: string = "SalesforceObject"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "SalesforceObjectDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

objectApiName

objectApiName: object

serializedName

serializedName: string = "typeProperties.objectApiName"

type

type: object

name

name: "Object" = "Object"

Const SalesforceSink

SalesforceSink: object
interface

An interface representing SalesforceSink. A copy activity Salesforce sink.

Optional externalIdFieldName

externalIdFieldName: any
member

{any} [externalIdFieldName] The name of the external ID field for upsert operation. Default value is 'Id' column. Type: string (or Expression with resultType string).

Optional ignoreNullValues

ignoreNullValues: any
member

{any} [ignoreNullValues] The flag indicating whether or not to ignore null values from input dataset (except key fields) during write operation. Default value is false. If set it to true, it means ADF will leave the data in the destination object unchanged when doing upsert/update operation and insert defined default value when doing insert operation, versus ADF will update the data in the destination object to NULL when doing upsert/update operation and insert NULL value when doing insert operation. Type: boolean (or Expression with resultType boolean).

Optional sinkRetryCount

sinkRetryCount: any
member

{any} [sinkRetryCount] Sink retry count. Type: integer (or Expression with resultType integer).

Optional sinkRetryWait

sinkRetryWait: any
member

{any} [sinkRetryWait] Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Optional writeBatchSize

writeBatchSize: any
member

{any} [writeBatchSize] Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

Optional writeBatchTimeout

writeBatchTimeout: any
member

{any} [writeBatchTimeout] Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Optional writeBehavior

member

{SalesforceSinkWriteBehavior} [writeBehavior] The write behavior for the operation. Default is Insert. Possible values include: 'Insert', 'Upsert'

serializedName

serializedName: string = "SalesforceSink"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySink.type.additionalProperties

className

className: string = "SalesforceSink"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySink.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySink"

modelProperties

modelProperties: object

externalIdFieldName

externalIdFieldName: object

serializedName

serializedName: string = "externalIdFieldName"

type

type: object

name

name: "Object" = "Object"

ignoreNullValues

ignoreNullValues: object

serializedName

serializedName: string = "ignoreNullValues"

type

type: object

name

name: "Object" = "Object"

writeBehavior

writeBehavior: object

serializedName

serializedName: string = "writeBehavior"

type

type: object

name

name: "String" = "String"

Const SalesforceSource

SalesforceSource: object
interface

An interface representing SalesforceSource. A copy activity Salesforce source.

Optional query

query: any
member

{any} [query] Database query. Type: string (or Expression with resultType string).

Optional readBehavior

member

{SalesforceSourceReadBehavior} [readBehavior] The read behavior for the operation. Default is Query. Possible values include: 'Query', 'QueryAll'

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "SalesforceSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "SalesforceSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

readBehavior

readBehavior: object

serializedName

serializedName: string = "readBehavior"

type

type: object

name

name: "String" = "String"

Const SapBWLinkedService

SapBWLinkedService: object
interface

An interface representing SapBWLinkedService. SAP Business Warehouse Linked Service.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

clientId

clientId: any
member

{any} clientId Client ID of the client on the BW system. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string).

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional password

password: SecretBaseUnion
member

{SecretBaseUnion} [password] Password to access the SAP BW server.

server

server: any
member

{any} server Host name of the SAP BW instance. Type: string (or Expression with resultType string).

systemNumber

systemNumber: any
member

{any} systemNumber System number of the BW system. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string).

Optional userName

userName: any
member

{any} [userName] Username to access the SAP BW server. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "SapBW"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "SapBWLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

clientId

clientId: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.clientId"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

password

password: object

serializedName

serializedName: string = "typeProperties.password"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

server

server: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.server"

type

type: object

name

name: "Object" = "Object"

systemNumber

systemNumber: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.systemNumber"

type

type: object

name

name: "Object" = "Object"

userName

userName: object

serializedName

serializedName: string = "typeProperties.userName"

type

type: object

name

name: "Object" = "Object"

Const SapCloudForCustomerLinkedService

SapCloudForCustomerLinkedService: object
interface

An interface representing SapCloudForCustomerLinkedService. Linked service for SAP Cloud for Customer.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Either encryptedCredential or username/password must be provided. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional password

password: SecretBaseUnion
member

{SecretBaseUnion} [password] The password for Basic authentication.

url

url: any
member

{any} url The URL of SAP Cloud for Customer OData API. For example, '[https://[tenantname].crm.ondemand.com/sap/c4c/odata/v1]'. Type: string (or Expression with resultType string).

Optional username

username: any
member

{any} [username] The username for Basic authentication. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "SapCloudForCustomer"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "SapCloudForCustomerLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

password

password: object

serializedName

serializedName: string = "typeProperties.password"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

url

url: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.url"

type

type: object

name

name: "Object" = "Object"

username

username: object

serializedName

serializedName: string = "typeProperties.username"

type

type: object

name

name: "Object" = "Object"

Const SapCloudForCustomerResourceDataset

SapCloudForCustomerResourceDataset: object
interface

An interface representing SapCloudForCustomerResourceDataset. The path of the SAP Cloud for Customer OData entity.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

path

path: any
member

{any} path The path of the SAP Cloud for Customer OData entity. Type: string (or Expression with resultType string).

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

serializedName

serializedName: string = "SapCloudForCustomerResource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "SapCloudForCustomerResourceDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

path

path: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.path"

type

type: object

name

name: "Object" = "Object"

Const SapCloudForCustomerSink

SapCloudForCustomerSink: object
interface

An interface representing SapCloudForCustomerSink. A copy activity SAP Cloud for Customer sink.

Optional sinkRetryCount

sinkRetryCount: any
member

{any} [sinkRetryCount] Sink retry count. Type: integer (or Expression with resultType integer).

Optional sinkRetryWait

sinkRetryWait: any
member

{any} [sinkRetryWait] Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Optional writeBatchSize

writeBatchSize: any
member

{any} [writeBatchSize] Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

Optional writeBatchTimeout

writeBatchTimeout: any
member

{any} [writeBatchTimeout] Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Optional writeBehavior

member

{SapCloudForCustomerSinkWriteBehavior} [writeBehavior] The write behavior for the operation. Default is 'Insert'. Possible values include: 'Insert', 'Update'

serializedName

serializedName: string = "SapCloudForCustomerSink"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySink.type.additionalProperties

className

className: string = "SapCloudForCustomerSink"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySink.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySink"

modelProperties

modelProperties: object

writeBehavior

writeBehavior: object

serializedName

serializedName: string = "writeBehavior"

type

type: object

name

name: "String" = "String"

Const SapCloudForCustomerSource

SapCloudForCustomerSource: object
interface

An interface representing SapCloudForCustomerSource. A copy activity source for SAP Cloud for Customer source.

Optional query

query: any
member

{any} [query] SAP Cloud for Customer OData query. For example, "$top=1". Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "SapCloudForCustomerSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "SapCloudForCustomerSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

Const SapEccLinkedService

SapEccLinkedService: object
interface

An interface representing SapEccLinkedService. Linked service for SAP ERP Central Component(SAP ECC).

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: undefined | string
member

{string} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Either encryptedCredential or username/password must be provided. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional password

password: SecretBaseUnion
member

{SecretBaseUnion} [password] The password for Basic authentication.

url

url: string
member

{string} url The URL of SAP ECC OData API. For example, '[https://hostname:port/sap/opu/odata/sap/servicename/]'. Type: string (or Expression with resultType string).

Optional username

username: undefined | string
member

{string} [username] The username for Basic authentication. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "SapEcc"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "SapEccLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "String" = "String"

password

password: object

serializedName

serializedName: string = "typeProperties.password"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

url

url: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.url"

type

type: object

name

name: "String" = "String"

username

username: object

serializedName

serializedName: string = "typeProperties.username"

type

type: object

name

name: "String" = "String"

Const SapEccResourceDataset

SapEccResourceDataset: object
interface

An interface representing SapEccResourceDataset. The path of the SAP ECC OData entity.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

path

path: string
member

{string} path The path of the SAP ECC OData entity. Type: string (or Expression with resultType string).

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

serializedName

serializedName: string = "SapEccResource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "SapEccResourceDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

path

path: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.path"

type

type: object

name

name: "String" = "String"

Const SapEccSource

SapEccSource: object
interface

An interface representing SapEccSource. A copy activity source for SAP ECC source.

Optional query

query: undefined | string
member

{string} [query] SAP ECC OData query. For example, "$top=1". Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "SapEccSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "SapEccSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "String" = "String"

Const SapHanaLinkedService

SapHanaLinkedService: object
interface

An interface representing SapHanaLinkedService. SAP HANA Linked Service.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional authenticationType

authenticationType: SapHanaAuthenticationType
member

{SapHanaAuthenticationType} [authenticationType] The authentication type to be used to connect to the SAP HANA server. Possible values include: 'Basic', 'Windows'

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional password

password: SecretBaseUnion
member

{SecretBaseUnion} [password] Password to access the SAP HANA server.

server

server: any
member

{any} server Host name of the SAP HANA server. Type: string (or Expression with resultType string).

Optional userName

userName: any
member

{any} [userName] Username to access the SAP HANA server. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "SapHana"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "SapHanaLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

authenticationType

authenticationType: object

serializedName

serializedName: string = "typeProperties.authenticationType"

type

type: object

name

name: "String" = "String"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

password

password: object

serializedName

serializedName: string = "typeProperties.password"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

server

server: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.server"

type

type: object

name

name: "Object" = "Object"

userName

userName: object

serializedName

serializedName: string = "typeProperties.userName"

type

type: object

name

name: "Object" = "Object"

Const ScheduleTrigger

ScheduleTrigger: object
interface

An interface representing ScheduleTrigger. Trigger that creates pipeline runs periodically, on schedule.

Optional description

description: undefined | string
member

{string} [description] Trigger description.

Optional pipelines

member

{TriggerPipelineReference[]} [pipelines] Pipelines that need to be started.

recurrence

member

{ScheduleTriggerRecurrence} recurrence Recurrence schedule configuration.

Optional runtimeState

runtimeState: TriggerRuntimeState
member

{TriggerRuntimeState} [runtimeState] Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. Possible values include: 'Started', 'Stopped', 'Disabled' NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ScheduleTrigger"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Trigger.type.additionalProperties

className

className: string = "ScheduleTrigger"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Trigger.type.polymorphicDiscriminator

uberParent

uberParent: string = "Trigger"

modelProperties

modelProperties: object

recurrence

recurrence: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.recurrence"

type

type: object

className

className: string = "ScheduleTriggerRecurrence"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

Const ScheduleTriggerRecurrence

ScheduleTriggerRecurrence: object
interface

An interface representing ScheduleTriggerRecurrence. The workflow trigger recurrence.

Optional endTime

endTime: Date
member

{Date} [endTime] The end time.

Optional frequency

member

{RecurrenceFrequency} [frequency] The frequency. Possible values include: 'NotSpecified', 'Minute', 'Hour', 'Day', 'Week', 'Month', 'Year'

Optional interval

interval: undefined | number
member

{number} [interval] The interval.

Optional schedule

member

{RecurrenceSchedule} [schedule] The recurrence schedule.

Optional startTime

startTime: Date
member

{Date} [startTime] The start time.

Optional timeZone

timeZone: undefined | string
member

{string} [timeZone] The time zone.

serializedName

serializedName: string = "ScheduleTriggerRecurrence"

type

type: object

className

className: string = "ScheduleTriggerRecurrence"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

modelProperties

modelProperties: object

endTime

endTime: object

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

frequency

frequency: object

serializedName

serializedName: string = "frequency"

type

type: object

name

name: "String" = "String"

interval

interval: object

serializedName

serializedName: string = "interval"

type

type: object

name

name: "Number" = "Number"

schedule

schedule: object

serializedName

serializedName: string = "schedule"

type

type: object

className

className: string = "RecurrenceSchedule"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

startTime

startTime: object

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

timeZone

timeZone: object

serializedName

serializedName: string = "timeZone"

type

type: object

name

name: "String" = "String"

Const ScriptAction

ScriptAction: object
interface

An interface representing ScriptAction. Custom script action to run on HDI ondemand cluster once it's up.

name

name: string
member

{string} name The user provided name of the script action.

Optional parameters

parameters: undefined | string
member

{string} [parameters] The parameters for the script action.

roles

roles: any
member

{any} roles The node types on which the script action should be executed.

uri

uri: string
member

{string} uri The URI for the script action.

serializedName

serializedName: string = "ScriptAction"

type

type: object

className

className: string = "ScriptAction"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

parameters

parameters: object

serializedName

serializedName: string = "parameters"

type

type: object

name

name: "String" = "String"

roles

roles: object

required

required: true = true

serializedName

serializedName: string = "roles"

type

type: object

name

name: "Object" = "Object"

uri

uri: object

required

required: true = true

serializedName

serializedName: string = "uri"

type

type: object

name

name: "String" = "String"

Const SecretBase

SecretBase: object
interface

An interface representing SecretBase. The base definition of a secret type.

serializedName

serializedName: string = "SecretBase"

type

type: object
member

{string} type Polymorphic Discriminator

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "SecretBase"

modelProperties

modelProperties: object

type

type: object

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "type"

serializedName

serializedName: string = "type"

Const SecureString

SecureString: object
interface

An interface representing SecureString. Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.

value

value: string
member

{string} value Value of secure string.

serializedName

serializedName: string = "SecureString"

type

type: object
member

{string} type Polymorphic Discriminator

className

className: string = "SecureString"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = SecretBase.type.polymorphicDiscriminator

uberParent

uberParent: string = "SecretBase"

modelProperties

modelProperties: object

value

value: object

required

required: true = true

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const SelfDependencyTumblingWindowTriggerReference

SelfDependencyTumblingWindowTriggerReference: object
interface

An interface representing SelfDependencyTumblingWindowTriggerReference. Self referenced tumbling window trigger dependency.

offset

offset: string
member

{string} offset Timespan applied to the start time of a tumbling window when evaluating dependency.

Optional size

size: undefined | string
member

{string} [size] The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used.

serializedName

serializedName: string = "SelfDependencyTumblingWindowTriggerReference"

type

type: object
member

{string} type Polymorphic Discriminator

className

className: string = "SelfDependencyTumblingWindowTriggerReference"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = DependencyReference.type.polymorphicDiscriminator

uberParent

uberParent: string = "DependencyReference"

modelProperties

modelProperties: object

offset

offset: object

required

required: true = true

serializedName

serializedName: string = "offset"

constraints

constraints: object

MaxLength

MaxLength: number = 15

MinLength

MinLength: number = 8

Pattern

Pattern: RegExp = /((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9]))/

type

type: object

name

name: "String" = "String"

size

size: object

serializedName

serializedName: string = "size"

constraints

constraints: object

MaxLength

MaxLength: number = 15

MinLength

MinLength: number = 8

Pattern

Pattern: RegExp = /((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9]))/

type

type: object

name

name: "String" = "String"

Const SelfHostedIntegrationRuntime

SelfHostedIntegrationRuntime: object
interface

An interface representing SelfHostedIntegrationRuntime. Self-hosted integration runtime.

Optional description

description: undefined | string
member

{string} [description] Integration runtime description.

Optional linkedInfo

member

{LinkedIntegrationRuntimeTypeUnion} [linkedInfo]

serializedName

serializedName: string = "SelfHosted"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = IntegrationRuntime.type.additionalProperties

className

className: string = "SelfHostedIntegrationRuntime"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = IntegrationRuntime.type.polymorphicDiscriminator

uberParent

uberParent: string = "IntegrationRuntime"

modelProperties

modelProperties: object

linkedInfo

linkedInfo: object

serializedName

serializedName: string = "typeProperties.linkedInfo"

type

type: object

className

className: string = "LinkedIntegrationRuntimeType"

name

name: "Composite" = "Composite"

Const SelfHostedIntegrationRuntimeNode

SelfHostedIntegrationRuntimeNode: object
interface

An interface representing SelfHostedIntegrationRuntimeNode. Properties of Self-hosted integration runtime node.

Optional capabilities

capabilities: undefined | object
member

{{ [propertyName: string]: string }} [capabilities] The integration runtime capabilities dictionary NOTE: This property will not be serialized. It can only be populated by the server.

Optional concurrentJobsLimit

concurrentJobsLimit: undefined | number
member

{number} [concurrentJobsLimit] Maximum concurrent jobs on the integration runtime node. NOTE: This property will not be serialized. It can only be populated by the server.

Optional expiryTime

expiryTime: Date
member

{Date} [expiryTime] The time at which the integration runtime will expire in ISO8601 format. NOTE: This property will not be serialized. It can only be populated by the server.

Optional hostServiceUri

hostServiceUri: undefined | string
member

{string} [hostServiceUri] URI for the host machine of the integration runtime. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isActiveDispatcher

isActiveDispatcher: undefined | false | true
member

{boolean} [isActiveDispatcher] Indicates whether this node is the active dispatcher for integration runtime requests. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastConnectTime

lastConnectTime: Date
member

{Date} [lastConnectTime] The most recent time at which the integration runtime was connected in ISO8601 format. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastEndUpdateTime

lastEndUpdateTime: Date
member

{Date} [lastEndUpdateTime] The last time for the integration runtime node update end. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastStartTime

lastStartTime: Date
member

{Date} [lastStartTime] The time the node last started up. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastStartUpdateTime

lastStartUpdateTime: Date
member

{Date} [lastStartUpdateTime] The last time for the integration runtime node update start. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastStopTime

lastStopTime: Date
member

{Date} [lastStopTime] The integration runtime node last stop time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastUpdateResult

member

{IntegrationRuntimeUpdateResult} [lastUpdateResult] The result of the last integration runtime node update. Possible values include: 'None', 'Succeed', 'Fail' NOTE: This property will not be serialized. It can only be populated by the server.

Optional machineName

machineName: undefined | string
member

{string} [machineName] Machine name of the integration runtime node. NOTE: This property will not be serialized. It can only be populated by the server.

Optional maxConcurrentJobs

maxConcurrentJobs: undefined | number
member

{number} [maxConcurrentJobs] The maximum concurrent jobs in this integration runtime. NOTE: This property will not be serialized. It can only be populated by the server.

Optional nodeName

nodeName: undefined | string
member

{string} [nodeName] Name of the integration runtime node. NOTE: This property will not be serialized. It can only be populated by the server.

Optional registerTime

registerTime: Date
member

{Date} [registerTime] The time at which the integration runtime node was registered in ISO8601 format. NOTE: This property will not be serialized. It can only be populated by the server.

Optional status

member

{SelfHostedIntegrationRuntimeNodeStatus} [status] Status of the integration runtime node. Possible values include: 'NeedRegistration', 'Online', 'Limited', 'Offline', 'Upgrading', 'Initializing', 'InitializeFailed' NOTE: This property will not be serialized. It can only be populated by the server.

Optional version

version: undefined | string
member

{string} [version] Version of the integration runtime node. NOTE: This property will not be serialized. It can only be populated by the server.

Optional versionStatus

versionStatus: undefined | string
member

{string} [versionStatus] Status of the integration runtime node version. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SelfHostedIntegrationRuntimeNode"

type

type: object

className

className: string = "SelfHostedIntegrationRuntimeNode"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

modelProperties

modelProperties: object

capabilities

capabilities: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "capabilities"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

concurrentJobsLimit

concurrentJobsLimit: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "concurrentJobsLimit"

type

type: object

name

name: "Number" = "Number"

expiryTime

expiryTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "expiryTime"

type

type: object

name

name: "DateTime" = "DateTime"

hostServiceUri

hostServiceUri: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "hostServiceUri"

type

type: object

name

name: "String" = "String"

isActiveDispatcher

isActiveDispatcher: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "isActiveDispatcher"

type

type: object

name

name: "Boolean" = "Boolean"

lastConnectTime

lastConnectTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "lastConnectTime"

type

type: object

name

name: "DateTime" = "DateTime"

lastEndUpdateTime

lastEndUpdateTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "lastEndUpdateTime"

type

type: object

name

name: "DateTime" = "DateTime"

lastStartTime

lastStartTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "lastStartTime"

type

type: object

name

name: "DateTime" = "DateTime"

lastStartUpdateTime

lastStartUpdateTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "lastStartUpdateTime"

type

type: object

name

name: "DateTime" = "DateTime"

lastStopTime

lastStopTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "lastStopTime"

type

type: object

name

name: "DateTime" = "DateTime"

lastUpdateResult

lastUpdateResult: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "lastUpdateResult"

type

type: object

name

name: "String" = "String"

machineName

machineName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "machineName"

type

type: object

name

name: "String" = "String"

maxConcurrentJobs

maxConcurrentJobs: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "maxConcurrentJobs"

type

type: object

name

name: "Number" = "Number"

nodeName

nodeName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nodeName"

type

type: object

name

name: "String" = "String"

registerTime

registerTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "registerTime"

type

type: object

name

name: "DateTime" = "DateTime"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

version

version: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "version"

type

type: object

name

name: "String" = "String"

versionStatus

versionStatus: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "versionStatus"

type

type: object

name

name: "String" = "String"

Const SelfHostedIntegrationRuntimeStatus

SelfHostedIntegrationRuntimeStatus: object
interface

An interface representing SelfHostedIntegrationRuntimeStatus. Self-hosted integration runtime status.

Optional autoUpdate

member

{IntegrationRuntimeAutoUpdate} [autoUpdate] Whether Self-hosted integration runtime auto update has been turned on. Possible values include: 'On', 'Off' NOTE: This property will not be serialized. It can only be populated by the server.

Optional autoUpdateETA

autoUpdateETA: Date
member

{Date} [autoUpdateETA] The estimated time when the self-hosted integration runtime will be updated. NOTE: This property will not be serialized. It can only be populated by the server.

Optional capabilities

capabilities: undefined | object
member

{{ [propertyName: string]: string }} [capabilities] Object with additional information about integration runtime capabilities. NOTE: This property will not be serialized. It can only be populated by the server.

Optional createTime

createTime: Date
member

{Date} [createTime] The time at which the integration runtime was created, in ISO8601 format. NOTE: This property will not be serialized. It can only be populated by the server.

Optional dataFactoryName

dataFactoryName: undefined | string
member

{string} [dataFactoryName] The data factory name which the integration runtime belong to. NOTE: This property will not be serialized. It can only be populated by the server.

Optional internalChannelEncryption

member

{IntegrationRuntimeInternalChannelEncryptionMode} [internalChannelEncryption] It is used to set the encryption mode for node-node communication channel (when more than 2 self-hosted integration runtime nodes exist). Possible values include: 'NotSet', 'SslEncrypted', 'NotEncrypted' NOTE: This property will not be serialized. It can only be populated by the server.

Optional latestVersion

latestVersion: undefined | string
member

{string} [latestVersion] The latest version on download center. NOTE: This property will not be serialized. It can only be populated by the server.

Optional links

member

{LinkedIntegrationRuntime[]} [links] The list of linked integration runtimes that are created to share with this integration runtime.

Optional localTimeZoneOffset

localTimeZoneOffset: undefined | string
member

{string} [localTimeZoneOffset] The local time zone offset in hours. NOTE: This property will not be serialized. It can only be populated by the server.

Optional nodes

member

{SelfHostedIntegrationRuntimeNode[]} [nodes] The list of nodes for this integration runtime.

Optional pushedVersion

pushedVersion: undefined | string
member

{string} [pushedVersion] The version that the integration runtime is going to update to. NOTE: This property will not be serialized. It can only be populated by the server.

Optional scheduledUpdateDate

scheduledUpdateDate: Date
member

{Date} [scheduledUpdateDate] The date at which the integration runtime will be scheduled to update, in ISO8601 format. NOTE: This property will not be serialized. It can only be populated by the server.

Optional serviceUrls

serviceUrls: string[]
member

{string[]} [serviceUrls] The URLs for the services used in integration runtime backend service. NOTE: This property will not be serialized. It can only be populated by the server.

Optional state

member

{IntegrationRuntimeState} [state] The state of integration runtime. Possible values include: 'Initial', 'Stopped', 'Started', 'Starting', 'Stopping', 'NeedRegistration', 'Online', 'Limited', 'Offline', 'AccessDenied' NOTE: This property will not be serialized. It can only be populated by the server.

Optional taskQueueId

taskQueueId: undefined | string
member

{string} [taskQueueId] The task queue id of the integration runtime. NOTE: This property will not be serialized. It can only be populated by the server.

Optional updateDelayOffset

updateDelayOffset: undefined | string
member

{string} [updateDelayOffset] The time in the date scheduled by service to update the integration runtime, e.g., PT03H is 3 hours NOTE: This property will not be serialized. It can only be populated by the server.

Optional version

version: undefined | string
member

{string} [version] Version of the integration runtime. NOTE: This property will not be serialized. It can only be populated by the server.

Optional versionStatus

versionStatus: undefined | string
member

{string} [versionStatus] Status of the integration runtime version. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SelfHosted"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = IntegrationRuntimeStatus.type.additionalProperties

className

className: string = "SelfHostedIntegrationRuntimeStatus"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = IntegrationRuntimeStatus.type.polymorphicDiscriminator

uberParent

uberParent: string = "IntegrationRuntimeStatus"

modelProperties

modelProperties: object

autoUpdate

autoUpdate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "typeProperties.autoUpdate"

type

type: object

name

name: "String" = "String"

autoUpdateETA

autoUpdateETA: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "typeProperties.autoUpdateETA"

type

type: object

name

name: "DateTime" = "DateTime"

capabilities

capabilities: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "typeProperties.capabilities"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

createTime

createTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "typeProperties.createTime"

type

type: object

name

name: "DateTime" = "DateTime"

internalChannelEncryption

internalChannelEncryption: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "typeProperties.internalChannelEncryption"

type

type: object

name

name: "String" = "String"

latestVersion

latestVersion: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "typeProperties.latestVersion"

type

type: object

name

name: "String" = "String"

links

links: object

serializedName

serializedName: string = "typeProperties.links"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LinkedIntegrationRuntime"

name

name: "Composite" = "Composite"

localTimeZoneOffset

localTimeZoneOffset: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "typeProperties.localTimeZoneOffset"

type

type: object

name

name: "String" = "String"

nodes

nodes: object

serializedName

serializedName: string = "typeProperties.nodes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SelfHostedIntegrationRuntimeNode"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

pushedVersion

pushedVersion: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "typeProperties.pushedVersion"

type

type: object

name

name: "String" = "String"

scheduledUpdateDate

scheduledUpdateDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "typeProperties.scheduledUpdateDate"

type

type: object

name

name: "DateTime" = "DateTime"

serviceUrls

serviceUrls: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "typeProperties.serviceUrls"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

taskQueueId

taskQueueId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "typeProperties.taskQueueId"

type

type: object

name

name: "String" = "String"

updateDelayOffset

updateDelayOffset: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "typeProperties.updateDelayOffset"

type

type: object

name

name: "String" = "String"

version

version: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "typeProperties.version"

type

type: object

name

name: "String" = "String"

versionStatus

versionStatus: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "typeProperties.versionStatus"

type

type: object

name

name: "String" = "String"

Const ServiceNowLinkedService

ServiceNowLinkedService: object
interface

An interface representing ServiceNowLinkedService. ServiceNow server linked service.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

authenticationType

authenticationType: ServiceNowAuthenticationType
member

{ServiceNowAuthenticationType} authenticationType The authentication type to use. Possible values include: 'Basic', 'OAuth2'

Optional clientId

clientId: any
member

{any} [clientId] The client id for OAuth2 authentication.

Optional clientSecret

clientSecret: SecretBaseUnion
member

{SecretBaseUnion} [clientSecret] The client secret for OAuth2 authentication.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

endpoint

endpoint: any
member

{any} endpoint The endpoint of the ServiceNow server. (i.e. .service-now.com)

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional password

password: SecretBaseUnion
member

{SecretBaseUnion} [password] The password corresponding to the user name for Basic and OAuth2 authentication.

Optional useEncryptedEndpoints

useEncryptedEndpoints: any
member

{any} [useEncryptedEndpoints] Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

Optional useHostVerification

useHostVerification: any
member

{any} [useHostVerification] Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.

Optional usePeerVerification

usePeerVerification: any
member

{any} [usePeerVerification] Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

Optional username

username: any
member

{any} [username] The user name used to connect to the ServiceNow server for Basic and OAuth2 authentication.

serializedName

serializedName: string = "ServiceNow"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "ServiceNowLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

authenticationType

authenticationType: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.authenticationType"

type

type: object

name

name: "String" = "String"

clientId

clientId: object

serializedName

serializedName: string = "typeProperties.clientId"

type

type: object

name

name: "Object" = "Object"

clientSecret

clientSecret: object

serializedName

serializedName: string = "typeProperties.clientSecret"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

endpoint

endpoint: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.endpoint"

type

type: object

name

name: "Object" = "Object"

password

password: object

serializedName

serializedName: string = "typeProperties.password"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

useEncryptedEndpoints

useEncryptedEndpoints: object

serializedName

serializedName: string = "typeProperties.useEncryptedEndpoints"

type

type: object

name

name: "Object" = "Object"

useHostVerification

useHostVerification: object

serializedName

serializedName: string = "typeProperties.useHostVerification"

type

type: object

name

name: "Object" = "Object"

usePeerVerification

usePeerVerification: object

serializedName

serializedName: string = "typeProperties.usePeerVerification"

type

type: object

name

name: "Object" = "Object"

username

username: object

serializedName

serializedName: string = "typeProperties.username"

type

type: object

name

name: "Object" = "Object"

Const ServiceNowObjectDataset

ServiceNowObjectDataset: object
interface

An interface representing ServiceNowObjectDataset. ServiceNow server dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Optional tableName

tableName: any
member

{any} [tableName] The table name. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "ServiceNowObject"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "ServiceNowObjectDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

tableName

tableName: object

serializedName

serializedName: string = "typeProperties.tableName"

type

type: object

name

name: "Object" = "Object"

Const ServiceNowSource

ServiceNowSource: object
interface

An interface representing ServiceNowSource. A copy activity ServiceNow server source.

Optional query

query: any
member

{any} [query] A query to retrieve data from source. Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "ServiceNowSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "ServiceNowSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

Const SetVariableActivity

SetVariableActivity: object
interface

An interface representing SetVariableActivity. Set value for a Variable.

Optional dependsOn

dependsOn: ActivityDependency[]
member

{ActivityDependency[]} [dependsOn] Activity depends on condition.

Optional description

description: undefined | string
member

{string} [description] Activity description.

name

name: string
member

{string} name Activity name.

Optional userProperties

userProperties: UserProperty[]
member

{UserProperty[]} [userProperties] Activity user properties.

Optional value

value: any
member

{any} [value] Value to be set. Could be a static value or Expression

Optional variableName

variableName: undefined | string
member

{string} [variableName] Name of the variable whose value needs to be set.

serializedName

serializedName: string = "SetVariable"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Activity.type.additionalProperties

className

className: string = "SetVariableActivity"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Activity.type.polymorphicDiscriminator

uberParent

uberParent: string = "Activity"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = "typeProperties.value"

type

type: object

name

name: "Object" = "Object"

variableName

variableName: object

serializedName

serializedName: string = "typeProperties.variableName"

type

type: object

name

name: "String" = "String"

Const SftpServerLinkedService

SftpServerLinkedService: object
interface

An interface representing SftpServerLinkedService. A linked service for an SSH File Transfer Protocol (SFTP) server.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional authenticationType

authenticationType: SftpAuthenticationType
member

{SftpAuthenticationType} [authenticationType] The authentication type to be used to connect to the FTP server. Possible values include: 'Basic', 'SshPublicKey'

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

host

host: any
member

{any} host The SFTP server host name. Type: string (or Expression with resultType string).

Optional hostKeyFingerprint

hostKeyFingerprint: any
member

{any} [hostKeyFingerprint] The host key finger-print of the SFTP server. When SkipHostKeyValidation is false, HostKeyFingerprint should be specified. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional passPhrase

passPhrase: SecretBaseUnion
member

{SecretBaseUnion} [passPhrase] The password to decrypt the SSH private key if the SSH private key is encrypted.

Optional password

password: SecretBaseUnion
member

{SecretBaseUnion} [password] Password to logon the SFTP server for Basic authentication.

Optional port

port: any
member

{any} [port] The TCP port number that the SFTP server uses to listen for client connections. Default value is 22. Type: integer (or Expression with resultType integer), minimum: 0.

Optional privateKeyContent

privateKeyContent: SecretBaseUnion
member

{SecretBaseUnion} [privateKeyContent] Base64 encoded SSH private key content for SshPublicKey authentication. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format.

Optional privateKeyPath

privateKeyPath: any
member

{any} [privateKeyPath] The SSH private key file path for SshPublicKey authentication. Only valid for on-premises copy. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format. Type: string (or Expression with resultType string).

Optional skipHostKeyValidation

skipHostKeyValidation: any
member

{any} [skipHostKeyValidation] If true, skip the SSH host key validation. Default value is false. Type: boolean (or Expression with resultType boolean).

Optional userName

userName: any
member

{any} [userName] The username used to log on to the SFTP server. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "Sftp"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "SftpServerLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

authenticationType

authenticationType: object

serializedName

serializedName: string = "typeProperties.authenticationType"

type

type: object

name

name: "String" = "String"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

host

host: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.host"

type

type: object

name

name: "Object" = "Object"

hostKeyFingerprint

hostKeyFingerprint: object

serializedName

serializedName: string = "typeProperties.hostKeyFingerprint"

type

type: object

name

name: "Object" = "Object"

passPhrase

passPhrase: object

serializedName

serializedName: string = "typeProperties.passPhrase"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

password

password: object

serializedName

serializedName: string = "typeProperties.password"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

port

port: object

serializedName

serializedName: string = "typeProperties.port"

type

type: object

name

name: "Object" = "Object"

privateKeyContent

privateKeyContent: object

serializedName

serializedName: string = "typeProperties.privateKeyContent"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

privateKeyPath

privateKeyPath: object

serializedName

serializedName: string = "typeProperties.privateKeyPath"

type

type: object

name

name: "Object" = "Object"

skipHostKeyValidation

skipHostKeyValidation: object

serializedName

serializedName: string = "typeProperties.skipHostKeyValidation"

type

type: object

name

name: "Object" = "Object"

userName

userName: object

serializedName

serializedName: string = "typeProperties.userName"

type

type: object

name

name: "Object" = "Object"

Const ShopifyLinkedService

ShopifyLinkedService: object
interface

An interface representing ShopifyLinkedService. Shopify Serivce linked service.

Optional accessToken

accessToken: SecretBaseUnion
member

{SecretBaseUnion} [accessToken] The API access token that can be used to access Shopify’s data. The token won't expire if it is offline mode.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

host

host: any
member

{any} host The endpoint of the Shopify server. (i.e. mystore.myshopify.com)

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional useEncryptedEndpoints

useEncryptedEndpoints: any
member

{any} [useEncryptedEndpoints] Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

Optional useHostVerification

useHostVerification: any
member

{any} [useHostVerification] Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.

Optional usePeerVerification

usePeerVerification: any
member

{any} [usePeerVerification] Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

serializedName

serializedName: string = "Shopify"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "ShopifyLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

accessToken

accessToken: object

serializedName

serializedName: string = "typeProperties.accessToken"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

host

host: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.host"

type

type: object

name

name: "Object" = "Object"

useEncryptedEndpoints

useEncryptedEndpoints: object

serializedName

serializedName: string = "typeProperties.useEncryptedEndpoints"

type

type: object

name

name: "Object" = "Object"

useHostVerification

useHostVerification: object

serializedName

serializedName: string = "typeProperties.useHostVerification"

type

type: object

name

name: "Object" = "Object"

usePeerVerification

usePeerVerification: object

serializedName

serializedName: string = "typeProperties.usePeerVerification"

type

type: object

name

name: "Object" = "Object"

Const ShopifyObjectDataset

ShopifyObjectDataset: object
interface

An interface representing ShopifyObjectDataset. Shopify Serivce dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Optional tableName

tableName: any
member

{any} [tableName] The table name. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "ShopifyObject"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "ShopifyObjectDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

tableName

tableName: object

serializedName

serializedName: string = "typeProperties.tableName"

type

type: object

name

name: "Object" = "Object"

Const ShopifySource

ShopifySource: object
interface

An interface representing ShopifySource. A copy activity Shopify Serivce source.

Optional query

query: any
member

{any} [query] A query to retrieve data from source. Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "ShopifySource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "ShopifySource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

Const SparkLinkedService

SparkLinkedService: object
interface

An interface representing SparkLinkedService. Spark Server linked service.

Optional allowHostNameCNMismatch

allowHostNameCNMismatch: any
member

{any} [allowHostNameCNMismatch] Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false.

Optional allowSelfSignedServerCert

allowSelfSignedServerCert: any
member

{any} [allowSelfSignedServerCert] Specifies whether to allow self-signed certificates from the server. The default value is false.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

authenticationType

authenticationType: SparkAuthenticationType
member

{SparkAuthenticationType} authenticationType The authentication method used to access the Spark server. Possible values include: 'Anonymous', 'Username', 'UsernameAndPassword', 'WindowsAzureHDInsightService'

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional enableSsl

enableSsl: any
member

{any} [enableSsl] Specifies whether the connections to the server are encrypted using SSL. The default value is false.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

host

host: any
member

{any} host IP address or host name of the Spark server

Optional httpPath

httpPath: any
member

{any} [httpPath] The partial URL corresponding to the Spark server.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional password

password: SecretBaseUnion
member

{SecretBaseUnion} [password] The password corresponding to the user name that you provided in the Username field

port

port: any
member

{any} port The TCP port that the Spark server uses to listen for client connections.

Optional serverType

serverType: SparkServerType
member

{SparkServerType} [serverType] The type of Spark server. Possible values include: 'SharkServer', 'SharkServer2', 'SparkThriftServer'

Optional thriftTransportProtocol

thriftTransportProtocol: SparkThriftTransportProtocol
member

{SparkThriftTransportProtocol} [thriftTransportProtocol] The transport protocol to use in the Thrift layer. Possible values include: 'Binary', 'SASL', 'HTTP '

Optional trustedCertPath

trustedCertPath: any
member

{any} [trustedCertPath] The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.

Optional useSystemTrustStore

useSystemTrustStore: any
member

{any} [useSystemTrustStore] Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.

Optional username

username: any
member

{any} [username] The user name that you use to access Spark Server.

serializedName

serializedName: string = "Spark"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "SparkLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

allowHostNameCNMismatch

allowHostNameCNMismatch: object

serializedName

serializedName: string = "typeProperties.allowHostNameCNMismatch"

type

type: object

name

name: "Object" = "Object"

allowSelfSignedServerCert

allowSelfSignedServerCert: object

serializedName

serializedName: string = "typeProperties.allowSelfSignedServerCert"

type

type: object

name

name: "Object" = "Object"

authenticationType

authenticationType: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.authenticationType"

type

type: object

name

name: "String" = "String"

enableSsl

enableSsl: object

serializedName

serializedName: string = "typeProperties.enableSsl"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

host

host: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.host"

type

type: object

name

name: "Object" = "Object"

httpPath

httpPath: object

serializedName

serializedName: string = "typeProperties.httpPath"

type

type: object

name

name: "Object" = "Object"

password

password: object

serializedName

serializedName: string = "typeProperties.password"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

port

port: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.port"

type

type: object

name

name: "Object" = "Object"

serverType

serverType: object

serializedName

serializedName: string = "typeProperties.serverType"

type

type: object

name

name: "String" = "String"

thriftTransportProtocol

thriftTransportProtocol: object

serializedName

serializedName: string = "typeProperties.thriftTransportProtocol"

type

type: object

name

name: "String" = "String"

trustedCertPath

trustedCertPath: object

serializedName

serializedName: string = "typeProperties.trustedCertPath"

type

type: object

name

name: "Object" = "Object"

useSystemTrustStore

useSystemTrustStore: object

serializedName

serializedName: string = "typeProperties.useSystemTrustStore"

type

type: object

name

name: "Object" = "Object"

username

username: object

serializedName

serializedName: string = "typeProperties.username"

type

type: object

name

name: "Object" = "Object"

Const SparkObjectDataset

SparkObjectDataset: object
interface

An interface representing SparkObjectDataset. Spark Server dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Optional tableName

tableName: any
member

{any} [tableName] The table name. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "SparkObject"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "SparkObjectDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

tableName

tableName: object

serializedName

serializedName: string = "typeProperties.tableName"

type

type: object

name

name: "Object" = "Object"

Const SparkSource

SparkSource: object
interface

An interface representing SparkSource. A copy activity Spark Server source.

Optional query

query: any
member

{any} [query] A query to retrieve data from source. Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "SparkSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "SparkSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

Const SqlDWSink

SqlDWSink: object
interface

An interface representing SqlDWSink. A copy activity SQL Data Warehouse sink.

Optional allowPolyBase

allowPolyBase: any
member

{any} [allowPolyBase] Indicates to use PolyBase to copy data into SQL Data Warehouse when applicable. Type: boolean (or Expression with resultType boolean).

Optional polyBaseSettings

polyBaseSettings: PolybaseSettings
member

{PolybaseSettings} [polyBaseSettings] Specifies PolyBase-related settings when allowPolyBase is true.

Optional preCopyScript

preCopyScript: any
member

{any} [preCopyScript] SQL pre-copy script. Type: string (or Expression with resultType string).

Optional sinkRetryCount

sinkRetryCount: any
member

{any} [sinkRetryCount] Sink retry count. Type: integer (or Expression with resultType integer).

Optional sinkRetryWait

sinkRetryWait: any
member

{any} [sinkRetryWait] Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Optional writeBatchSize

writeBatchSize: any
member

{any} [writeBatchSize] Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

Optional writeBatchTimeout

writeBatchTimeout: any
member

{any} [writeBatchTimeout] Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "SqlDWSink"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySink.type.additionalProperties

className

className: string = "SqlDWSink"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySink.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySink"

modelProperties

modelProperties: object

allowPolyBase

allowPolyBase: object

serializedName

serializedName: string = "allowPolyBase"

type

type: object

name

name: "Object" = "Object"

polyBaseSettings

polyBaseSettings: object

serializedName

serializedName: string = "polyBaseSettings"

type

type: object

className

className: string = "PolybaseSettings"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

preCopyScript

preCopyScript: object

serializedName

serializedName: string = "preCopyScript"

type

type: object

name

name: "Object" = "Object"

Const SqlDWSource

SqlDWSource: object
interface

An interface representing SqlDWSource. A copy activity SQL Data Warehouse source.

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Optional sqlReaderQuery

sqlReaderQuery: any
member

{any} [sqlReaderQuery] SQL Data Warehouse reader query. Type: string (or Expression with resultType string).

Optional sqlReaderStoredProcedureName

sqlReaderStoredProcedureName: any
member

{any} [sqlReaderStoredProcedureName] Name of the stored procedure for a SQL Data Warehouse source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string).

Optional storedProcedureParameters

storedProcedureParameters: any
member

{any} [storedProcedureParameters] Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}". Type: object (or Expression with resultType object), itemType: StoredProcedureParameter.

serializedName

serializedName: string = "SqlDWSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "SqlDWSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

sqlReaderQuery

sqlReaderQuery: object

serializedName

serializedName: string = "sqlReaderQuery"

type

type: object

name

name: "Object" = "Object"

sqlReaderStoredProcedureName

sqlReaderStoredProcedureName: object

serializedName

serializedName: string = "sqlReaderStoredProcedureName"

type

type: object

name

name: "Object" = "Object"

storedProcedureParameters

storedProcedureParameters: object

serializedName

serializedName: string = "storedProcedureParameters"

type

type: object

name

name: "Object" = "Object"

Const SqlServerLinkedService

SqlServerLinkedService: object
interface

An interface representing SqlServerLinkedService. SQL Server linked service.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

connectionString

connectionString: any
member

{any} connectionString The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional password

password: SecretBaseUnion
member

{SecretBaseUnion} [password] The on-premises Windows authentication password.

Optional userName

userName: any
member

{any} [userName] The on-premises Windows authentication user name. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "SqlServer"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "SqlServerLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

connectionString

connectionString: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.connectionString"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

password

password: object

serializedName

serializedName: string = "typeProperties.password"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

userName

userName: object

serializedName

serializedName: string = "typeProperties.userName"

type

type: object

name

name: "Object" = "Object"

Const SqlServerStoredProcedureActivity

SqlServerStoredProcedureActivity: object
interface

An interface representing SqlServerStoredProcedureActivity. SQL stored procedure activity type.

Optional dependsOn

dependsOn: ActivityDependency[]
member

{ActivityDependency[]} [dependsOn] Activity depends on condition.

Optional description

description: undefined | string
member

{string} [description] Activity description.

Optional linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} [linkedServiceName] Linked service reference.

name

name: string
member

{string} name Activity name.

Optional policy

member

{ActivityPolicy} [policy] Activity policy.

storedProcedureName

storedProcedureName: any
member

{any} storedProcedureName Stored procedure name. Type: string (or Expression with resultType string).

Optional storedProcedureParameters

storedProcedureParameters: undefined | object
member

{{ [propertyName: string]: StoredProcedureParameter }} [storedProcedureParameters] Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}".

Optional userProperties

userProperties: UserProperty[]
member

{UserProperty[]} [userProperties] Activity user properties.

serializedName

serializedName: string = "SqlServerStoredProcedure"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Activity.type.additionalProperties

className

className: string = "SqlServerStoredProcedureActivity"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Activity.type.polymorphicDiscriminator

uberParent

uberParent: string = "Activity"

modelProperties

modelProperties: object

storedProcedureName

storedProcedureName: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.storedProcedureName"

type

type: object

name

name: "Object" = "Object"

storedProcedureParameters

storedProcedureParameters: object

serializedName

serializedName: string = "typeProperties.storedProcedureParameters"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

className

className: string = "StoredProcedureParameter"

name

name: "Composite" = "Composite"

Const SqlServerTableDataset

SqlServerTableDataset: object
interface

An interface representing SqlServerTableDataset. The on-premises SQL Server dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

tableName

tableName: any
member

{any} tableName The table name of the SQL Server dataset. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "SqlServerTable"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "SqlServerTableDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

tableName

tableName: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.tableName"

type

type: object

name

name: "Object" = "Object"

Const SqlSink

SqlSink: object
interface

An interface representing SqlSink. A copy activity SQL sink.

Optional preCopyScript

preCopyScript: any
member

{any} [preCopyScript] SQL pre-copy script. Type: string (or Expression with resultType string).

Optional sinkRetryCount

sinkRetryCount: any
member

{any} [sinkRetryCount] Sink retry count. Type: integer (or Expression with resultType integer).

Optional sinkRetryWait

sinkRetryWait: any
member

{any} [sinkRetryWait] Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Optional sqlWriterStoredProcedureName

sqlWriterStoredProcedureName: any
member

{any} [sqlWriterStoredProcedureName] SQL writer stored procedure name. Type: string (or Expression with resultType string).

Optional sqlWriterTableType

sqlWriterTableType: any
member

{any} [sqlWriterTableType] SQL writer table type. Type: string (or Expression with resultType string).

Optional storedProcedureParameters

storedProcedureParameters: undefined | object
member

{{ [propertyName: string]: StoredProcedureParameter }} [storedProcedureParameters] SQL stored procedure parameters.

Optional writeBatchSize

writeBatchSize: any
member

{any} [writeBatchSize] Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

Optional writeBatchTimeout

writeBatchTimeout: any
member

{any} [writeBatchTimeout] Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "SqlSink"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySink.type.additionalProperties

className

className: string = "SqlSink"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySink.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySink"

modelProperties

modelProperties: object

preCopyScript

preCopyScript: object

serializedName

serializedName: string = "preCopyScript"

type

type: object

name

name: "Object" = "Object"

sqlWriterStoredProcedureName

sqlWriterStoredProcedureName: object

serializedName

serializedName: string = "sqlWriterStoredProcedureName"

type

type: object

name

name: "Object" = "Object"

sqlWriterTableType

sqlWriterTableType: object

serializedName

serializedName: string = "sqlWriterTableType"

type

type: object

name

name: "Object" = "Object"

storedProcedureParameters

storedProcedureParameters: object

serializedName

serializedName: string = "storedProcedureParameters"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

className

className: string = "StoredProcedureParameter"

name

name: "Composite" = "Composite"

Const SqlSource

SqlSource: object
interface

An interface representing SqlSource. A copy activity SQL source.

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Optional sqlReaderQuery

sqlReaderQuery: any
member

{any} [sqlReaderQuery] SQL reader query. Type: string (or Expression with resultType string).

Optional sqlReaderStoredProcedureName

sqlReaderStoredProcedureName: any
member

{any} [sqlReaderStoredProcedureName] Name of the stored procedure for a SQL Database source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string).

Optional storedProcedureParameters

storedProcedureParameters: undefined | object
member

{{ [propertyName: string]: StoredProcedureParameter }} [storedProcedureParameters] Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}".

serializedName

serializedName: string = "SqlSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "SqlSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

sqlReaderQuery

sqlReaderQuery: object

serializedName

serializedName: string = "sqlReaderQuery"

type

type: object

name

name: "Object" = "Object"

sqlReaderStoredProcedureName

sqlReaderStoredProcedureName: object

serializedName

serializedName: string = "sqlReaderStoredProcedureName"

type

type: object

name

name: "Object" = "Object"

storedProcedureParameters

storedProcedureParameters: object

serializedName

serializedName: string = "storedProcedureParameters"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

className

className: string = "StoredProcedureParameter"

name

name: "Composite" = "Composite"

Const SquareLinkedService

SquareLinkedService: object
interface

An interface representing SquareLinkedService. Square Serivce linked service.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

clientId

clientId: any
member

{any} clientId The client ID associated with your Square application.

Optional clientSecret

clientSecret: SecretBaseUnion
member

{SecretBaseUnion} [clientSecret] The client secret associated with your Square application.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

host

host: any
member

{any} host The URL of the Square instance. (i.e. mystore.mysquare.com)

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

redirectUri

redirectUri: any
member

{any} redirectUri The redirect URL assigned in the Square application dashboard. (i.e. http://localhost:2500)

Optional useEncryptedEndpoints

useEncryptedEndpoints: any
member

{any} [useEncryptedEndpoints] Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

Optional useHostVerification

useHostVerification: any
member

{any} [useHostVerification] Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.

Optional usePeerVerification

usePeerVerification: any
member

{any} [usePeerVerification] Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

serializedName

serializedName: string = "Square"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "SquareLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

clientId

clientId: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.clientId"

type

type: object

name

name: "Object" = "Object"

clientSecret

clientSecret: object

serializedName

serializedName: string = "typeProperties.clientSecret"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

host

host: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.host"

type

type: object

name

name: "Object" = "Object"

redirectUri

redirectUri: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.redirectUri"

type

type: object

name

name: "Object" = "Object"

useEncryptedEndpoints

useEncryptedEndpoints: object

serializedName

serializedName: string = "typeProperties.useEncryptedEndpoints"

type

type: object

name

name: "Object" = "Object"

useHostVerification

useHostVerification: object

serializedName

serializedName: string = "typeProperties.useHostVerification"

type

type: object

name

name: "Object" = "Object"

usePeerVerification

usePeerVerification: object

serializedName

serializedName: string = "typeProperties.usePeerVerification"

type

type: object

name

name: "Object" = "Object"

Const SquareObjectDataset

SquareObjectDataset: object
interface

An interface representing SquareObjectDataset. Square Serivce dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Optional tableName

tableName: any
member

{any} [tableName] The table name. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "SquareObject"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "SquareObjectDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

tableName

tableName: object

serializedName

serializedName: string = "typeProperties.tableName"

type

type: object

name

name: "Object" = "Object"

Const SquareSource

SquareSource: object
interface

An interface representing SquareSource. A copy activity Square Serivce source.

Optional query

query: any
member

{any} [query] A query to retrieve data from source. Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "SquareSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "SquareSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

Const StagingSettings

StagingSettings: object
interface

An interface representing StagingSettings. Staging settings.

Optional enableCompression

enableCompression: any
member

{any} [enableCompression] Specifies whether to use compression when copying data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean).

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Staging linked service reference.

Optional path

path: any
member

{any} [path] The path to storage for storing the interim data. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "StagingSettings"

type

type: object

className

className: string = "StagingSettings"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

modelProperties

modelProperties: object

enableCompression

enableCompression: object

serializedName

serializedName: string = "enableCompression"

type

type: object

name

name: "Object" = "Object"

linkedServiceName

linkedServiceName: object

defaultValue

defaultValue: object

Type declaration

required

required: true = true

serializedName

serializedName: string = "linkedServiceName"

type

type: object

className

className: string = "LinkedServiceReference"

name

name: "Composite" = "Composite"

path

path: object

serializedName

serializedName: string = "path"

type

type: object

name

name: "Object" = "Object"

Const StoredProcedureParameter

StoredProcedureParameter: object
interface

An interface representing StoredProcedureParameter. SQL stored procedure parameter.

Optional value

value: any
member

{any} [value] Stored procedure parameter value. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "StoredProcedureParameter"

Optional type

type: object
member

{StoredProcedureParameterType} [type] Stored procedure parameter type. Possible values include: 'String', 'Int', 'Decimal', 'Guid', 'Boolean', 'Date'

className

className: string = "StoredProcedureParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "Object" = "Object"

Const SubResource

SubResource: object
interface

An interface representing SubResource. Azure Data Factory nested resource, which belongs to a factory.

extends

BaseResource

Optional etag

etag: undefined | string
member

{string} [etag] Etag identifies change in the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string
member

{string} [id] The resource identifier. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string
member

{string} [name] The resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SubResource"

Optional type

type: object
member

{string} [type] The resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

etag

etag: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const SybaseLinkedService

SybaseLinkedService: object
interface

An interface representing SybaseLinkedService. Linked service for Sybase data source.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional authenticationType

authenticationType: SybaseAuthenticationType
member

{SybaseAuthenticationType} [authenticationType] AuthenticationType to be used for connection. Possible values include: 'Basic', 'Windows'

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

database

database: any
member

{any} database Database name for connection. Type: string (or Expression with resultType string).

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional password

password: SecretBaseUnion
member

{SecretBaseUnion} [password] Password for authentication.

Optional schema

schema: any
member

{any} [schema] Schema name for connection. Type: string (or Expression with resultType string).

server

server: any
member

{any} server Server name for connection. Type: string (or Expression with resultType string).

Optional username

username: any
member

{any} [username] Username for authentication. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "Sybase"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "SybaseLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

authenticationType

authenticationType: object

serializedName

serializedName: string = "typeProperties.authenticationType"

type

type: object

name

name: "String" = "String"

database

database: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.database"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

password

password: object

serializedName

serializedName: string = "typeProperties.password"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

schema

schema: object

serializedName

serializedName: string = "typeProperties.schema"

type

type: object

name

name: "Object" = "Object"

server

server: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.server"

type

type: object

name

name: "Object" = "Object"

username

username: object

serializedName

serializedName: string = "typeProperties.username"

type

type: object

name

name: "Object" = "Object"

Const TabularTranslator

TabularTranslator: object
interface

An interface representing TabularTranslator. A copy activity tabular translator.

Optional columnMappings

columnMappings: any
member

{any} [columnMappings] Column mappings. Example: "UserId: MyUserId, Group: MyGroup, Name: MyName" Type: string (or Expression with resultType string).

Optional schemaMapping

schemaMapping: any
member

{any} [schemaMapping] The schema mapping to map between tabular data and hierarchical data. Example: {"Column1": "$.Column1", "Column2": "$.Column2.Property1", "Column3": "$.Column2.Property2"}. Type: object (or Expression with resultType object).

serializedName

serializedName: string = "TabularTranslator"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopyTranslator.type.additionalProperties

className

className: string = "TabularTranslator"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopyTranslator.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopyTranslator"

modelProperties

modelProperties: object

columnMappings

columnMappings: object

serializedName

serializedName: string = "columnMappings"

type

type: object

name

name: "Object" = "Object"

schemaMapping

schemaMapping: object

serializedName

serializedName: string = "schemaMapping"

type

type: object

name

name: "Object" = "Object"

Const TeradataLinkedService

TeradataLinkedService: object
interface

An interface representing TeradataLinkedService. Linked service for Teradata data source.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional authenticationType

authenticationType: TeradataAuthenticationType
member

{TeradataAuthenticationType} [authenticationType] AuthenticationType to be used for connection. Possible values include: 'Basic', 'Windows'

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional password

password: SecretBaseUnion
member

{SecretBaseUnion} [password] Password for authentication.

server

server: any
member

{any} server Server name for connection. Type: string (or Expression with resultType string).

Optional username

username: any
member

{any} [username] Username for authentication. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "Teradata"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "TeradataLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

authenticationType

authenticationType: object

serializedName

serializedName: string = "typeProperties.authenticationType"

type

type: object

name

name: "String" = "String"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

password

password: object

serializedName

serializedName: string = "typeProperties.password"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

server

server: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.server"

type

type: object

name

name: "Object" = "Object"

username

username: object

serializedName

serializedName: string = "typeProperties.username"

type

type: object

name

name: "Object" = "Object"

Const TextFormat

TextFormat: object
interface

An interface representing TextFormat. The data stored in text format.

Optional columnDelimiter

columnDelimiter: any
member

{any} [columnDelimiter] The column delimiter. Type: string (or Expression with resultType string).

Optional deserializer

deserializer: any
member

{any} [deserializer] Deserializer. Type: string (or Expression with resultType string).

Optional encodingName

encodingName: any
member

{any} [encodingName] The code page name of the preferred encoding. If miss, the default value is ΓÇ£utf-8ΓÇ¥, unless BOM denotes another Unicode encoding. Refer to the ΓÇ£NameΓÇ¥ column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string).

Optional escapeChar

escapeChar: any
member

{any} [escapeChar] The escape character. Type: string (or Expression with resultType string).

Optional firstRowAsHeader

firstRowAsHeader: any
member

{any} [firstRowAsHeader] When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean).

Optional nullValue

nullValue: any
member

{any} [nullValue] The null value string. Type: string (or Expression with resultType string).

Optional quoteChar

quoteChar: any
member

{any} [quoteChar] The quote character. Type: string (or Expression with resultType string).

Optional rowDelimiter

rowDelimiter: any
member

{any} [rowDelimiter] The row delimiter. Type: string (or Expression with resultType string).

Optional serializer

serializer: any
member

{any} [serializer] Serializer. Type: string (or Expression with resultType string).

Optional skipLineCount

skipLineCount: any
member

{any} [skipLineCount] The number of lines/rows to be skipped when parsing text files. The default value is 0. Type: integer (or Expression with resultType integer).

Optional treatEmptyAsNull

treatEmptyAsNull: any
member

{any} [treatEmptyAsNull] Treat empty column values in the text file as null. The default value is true. Type: boolean (or Expression with resultType boolean).

serializedName

serializedName: string = "TextFormat"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = DatasetStorageFormat.type.additionalProperties

className

className: string = "TextFormat"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = DatasetStorageFormat.type.polymorphicDiscriminator

uberParent

uberParent: string = "DatasetStorageFormat"

modelProperties

modelProperties: object

columnDelimiter

columnDelimiter: object

serializedName

serializedName: string = "columnDelimiter"

type

type: object

name

name: "Object" = "Object"

encodingName

encodingName: object

serializedName

serializedName: string = "encodingName"

type

type: object

name

name: "Object" = "Object"

escapeChar

escapeChar: object

serializedName

serializedName: string = "escapeChar"

type

type: object

name

name: "Object" = "Object"

firstRowAsHeader

firstRowAsHeader: object

serializedName

serializedName: string = "firstRowAsHeader"

type

type: object

name

name: "Object" = "Object"

nullValue

nullValue: object

serializedName

serializedName: string = "nullValue"

type

type: object

name

name: "Object" = "Object"

quoteChar

quoteChar: object

serializedName

serializedName: string = "quoteChar"

type

type: object

name

name: "Object" = "Object"

rowDelimiter

rowDelimiter: object

serializedName

serializedName: string = "rowDelimiter"

type

type: object

name

name: "Object" = "Object"

skipLineCount

skipLineCount: object

serializedName

serializedName: string = "skipLineCount"

type

type: object

name

name: "Object" = "Object"

treatEmptyAsNull

treatEmptyAsNull: object

serializedName

serializedName: string = "treatEmptyAsNull"

type

type: object

name

name: "Object" = "Object"

Const Trigger

Trigger: object
interface

An interface representing Trigger. Azure data factory nested object which contains information about creating pipeline run

Optional description

description: undefined | string
member

{string} [description] Trigger description.

Optional runtimeState

runtimeState: TriggerRuntimeState
member

{TriggerRuntimeState} [runtimeState] Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. Possible values include: 'Started', 'Stopped', 'Disabled' NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Trigger"

type

type: object
member

{string} type Polymorphic Discriminator

className

className: string = "Trigger"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "Trigger"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

runtimeState

runtimeState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "runtimeState"

type

type: object

name

name: "String" = "String"

type

type: object

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "type"

serializedName

serializedName: string = "type"

Const TriggerDependencyReference

TriggerDependencyReference: object
interface

An interface representing TriggerDependencyReference. Trigger referenced dependency.

referenceTrigger

referenceTrigger: TriggerReference
member

{TriggerReference} referenceTrigger Referenced trigger.

serializedName

serializedName: string = "TriggerDependencyReference"

type

type: object
member

{string} type Polymorphic Discriminator

className

className: string = "TriggerDependencyReference"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = DependencyReference.type.polymorphicDiscriminator

uberParent

uberParent: string = "DependencyReference"

modelProperties

modelProperties: object

referenceTrigger

referenceTrigger: object

defaultValue

defaultValue: object

Type declaration

required

required: true = true

serializedName

serializedName: string = "referenceTrigger"

type

type: object

className

className: string = "TriggerReference"

name

name: "Composite" = "Composite"

Const TriggerListResponse

TriggerListResponse: object
interface

An interface representing the TriggerListResponse. A list of trigger resources.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] The link to the next page of results, if any remaining results exist.

serializedName

serializedName: string = "TriggerListResponse"

__@iterator

  • Iterator

    Returns IterableIterator<TriggerResource>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<TriggerResource>[]

      Additional items to add to the end of array1.

    Returns TriggerResource[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns TriggerResource[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, TriggerResource]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: TriggerResource, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: TriggerResource

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): TriggerResource[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns TriggerResource[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): TriggerResource | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns TriggerResource | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: TriggerResource, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: TriggerResource

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: TriggerResource, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: TriggerResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: TriggerResource, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: TriggerResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns TriggerResource | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns TriggerResource

  • Parameters

    Returns TriggerResource

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns TriggerResource

  • Parameters

    Returns TriggerResource

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns TriggerResource[]

shift

  • Removes the first element from an array and returns it.

    Returns TriggerResource | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): TriggerResource[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns TriggerResource[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns TriggerResource[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: TriggerResource[]

      Elements to insert into the array in place of the deleted elements.

    Returns TriggerResource[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: TriggerResource[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<TriggerResource>

type

type: object

className

className: string = "TriggerListResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TriggerResource"

name

name: "Composite" = "Composite"

Const TriggerPipelineReference

TriggerPipelineReference: object
interface

An interface representing TriggerPipelineReference. Pipeline that needs to be triggered with the given parameters.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: any }} [parameters] Pipeline parameters.

Optional pipelineReference

pipelineReference: PipelineReference
member

{PipelineReference} [pipelineReference] Pipeline reference.

serializedName

serializedName: string = "TriggerPipelineReference"

type

type: object

className

className: string = "TriggerPipelineReference"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

parameters

parameters: object

serializedName

serializedName: string = "parameters"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Object" = "Object"

pipelineReference

pipelineReference: object

serializedName

serializedName: string = "pipelineReference"

type

type: object

className

className: string = "PipelineReference"

name

name: "Composite" = "Composite"

Const TriggerReference

TriggerReference: object
interface

An interface representing TriggerReference. Trigger reference type.

referenceName

referenceName: string
member

{string} referenceName Reference trigger name.

serializedName

serializedName: string = "TriggerReference"

type

type: object

className

className: string = "TriggerReference"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

referenceName

referenceName: object

required

required: true = true

serializedName

serializedName: string = "referenceName"

type

type: object

name

name: "String" = "String"

type

type: object

defaultValue

defaultValue: string = "TriggerReference"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const TriggerResource

TriggerResource: object
interface

An interface representing TriggerResource. Trigger resource type.

extends

SubResource

Optional etag

etag: undefined | string
member

{string} [etag] Etag identifies change in the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string
member

{string} [id] The resource identifier. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string
member

{string} [name] The resource name. NOTE: This property will not be serialized. It can only be populated by the server.

properties

properties: TriggerUnion
member

{TriggerUnion} properties Properties of the trigger.

serializedName

serializedName: string = "TriggerResource"

Optional type

type: object
member

{string} [type] The resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "TriggerResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

required

required: true = true

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "Trigger"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

Const TriggerRun

TriggerRun: object
interface

An interface representing TriggerRun. Trigger runs.

Optional message

message: undefined | string
member

{string} [message] Trigger error message. NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: undefined | object
member

{{ [propertyName: string]: string }} [properties] List of property name and value related to trigger run. Name, value pair depends on type of trigger. NOTE: This property will not be serialized. It can only be populated by the server.

Optional status

member

{TriggerRunStatus} [status] Trigger run status. Possible values include: 'Succeeded', 'Failed', 'Inprogress' NOTE: This property will not be serialized. It can only be populated by the server.

Optional triggerName

triggerName: undefined | string
member

{string} [triggerName] Trigger name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional triggerRunId

triggerRunId: undefined | string
member

{string} [triggerRunId] Trigger run id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional triggerRunTimestamp

triggerRunTimestamp: Date
member

{Date} [triggerRunTimestamp] Trigger run start time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional triggerType

triggerType: undefined | string
member

{string} [triggerType] Trigger type. NOTE: This property will not be serialized. It can only be populated by the server.

Optional triggeredPipelines

triggeredPipelines: undefined | object
member

{{ [propertyName: string]: string }} [triggeredPipelines] List of pipeline name and run Id triggered by the trigger run. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "TriggerRun"

type

type: object

className

className: string = "TriggerRun"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

modelProperties

modelProperties: object

message

message: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

properties

properties: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

triggerName

triggerName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "triggerName"

type

type: object

name

name: "String" = "String"

triggerRunId

triggerRunId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "triggerRunId"

type

type: object

name

name: "String" = "String"

triggerRunTimestamp

triggerRunTimestamp: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "triggerRunTimestamp"

type

type: object

name

name: "DateTime" = "DateTime"

triggerType

triggerType: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "triggerType"

type

type: object

name

name: "String" = "String"

triggeredPipelines

triggeredPipelines: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "triggeredPipelines"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const TriggerRunsQueryResponse

TriggerRunsQueryResponse: object
interface

An interface representing TriggerRunsQueryResponse. A list of trigger runs.

Optional continuationToken

continuationToken: undefined | string
member

{string} [continuationToken] The continuation token for getting the next page of results, if any remaining results exist, null otherwise.

value

value: TriggerRun[]
member

{TriggerRun[]} value List of trigger runs.

serializedName

serializedName: string = "TriggerRunsQueryResponse"

type

type: object

className

className: string = "TriggerRunsQueryResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

continuationToken

continuationToken: object

serializedName

serializedName: string = "continuationToken"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TriggerRun"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

Const TumblingWindowTrigger

TumblingWindowTrigger: object
interface

An interface representing TumblingWindowTrigger. Trigger that schedules pipeline runs for all fixed time interval windows from a start time without gaps and also supports backfill scenarios (when start time is in the past).

Optional delay

delay: any
member

{any} [delay] Specifies how long the trigger waits past due time before triggering new run. It doesn't alter window start and end time. The default is 0. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Optional dependsOn

member

{DependencyReferenceUnion[]} [dependsOn] Triggers that this trigger depends on. Only tumbling window triggers are supported.

Optional description

description: undefined | string
member

{string} [description] Trigger description.

Optional endTime

endTime: Date
member

{Date} [endTime] The end time for the time period for the trigger during which events are fired for windows that are ready. Only UTC time is currently supported.

frequency

member

{TumblingWindowFrequency} frequency The frequency of the time windows. Possible values include: 'Minute', 'Hour'

interval

interval: number
member

{number} interval The interval of the time windows. The minimum interval allowed is 15 Minutes.

maxConcurrency

maxConcurrency: number
member

{number} maxConcurrency The max number of parallel time windows (ready for execution) for which a new run is triggered.

pipelineProperty

pipelineProperty: TriggerPipelineReference
member

{TriggerPipelineReference} pipelineProperty Pipeline for which runs are created when an event is fired for trigger window that is ready.

Optional retryPolicy

retryPolicy: RetryPolicy
member

{RetryPolicy} [retryPolicy] Retry policy that will be applied for failed pipeline runs.

Optional runtimeState

runtimeState: TriggerRuntimeState
member

{TriggerRuntimeState} [runtimeState] Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. Possible values include: 'Started', 'Stopped', 'Disabled' NOTE: This property will not be serialized. It can only be populated by the server.

startTime

startTime: Date
member

{Date} startTime The start time for the time period for the trigger during which events are fired for windows that are ready. Only UTC time is currently supported.

serializedName

serializedName: string = "TumblingWindowTrigger"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Trigger.type.additionalProperties

className

className: string = "TumblingWindowTrigger"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Trigger.type.polymorphicDiscriminator

uberParent

uberParent: string = "Trigger"

modelProperties

modelProperties: object

delay

delay: object

serializedName

serializedName: string = "typeProperties.delay"

type

type: object

name

name: "Object" = "Object"

dependsOn

dependsOn: object

serializedName

serializedName: string = "typeProperties.dependsOn"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DependencyReference"

name

name: "Composite" = "Composite"

endTime

endTime: object

serializedName

serializedName: string = "typeProperties.endTime"

type

type: object

name

name: "DateTime" = "DateTime"

frequency

frequency: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.frequency"

type

type: object

name

name: "String" = "String"

interval

interval: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.interval"

type

type: object

name

name: "Number" = "Number"

maxConcurrency

maxConcurrency: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.maxConcurrency"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 50

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

pipelineProperty

pipelineProperty: object

defaultValue

defaultValue: object

Type declaration

required

required: true = true

serializedName

serializedName: string = "pipeline"

type

type: object

className

className: string = "TriggerPipelineReference"

name

name: "Composite" = "Composite"

retryPolicy

retryPolicy: object

serializedName

serializedName: string = "typeProperties.retryPolicy"

type

type: object

className

className: string = "RetryPolicy"

name

name: "Composite" = "Composite"

startTime

startTime: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.startTime"

type

type: object

name

name: "DateTime" = "DateTime"

Const TumblingWindowTriggerDependencyReference

TumblingWindowTriggerDependencyReference: object
interface

An interface representing TumblingWindowTriggerDependencyReference. Referenced tumbling window trigger dependency.

Optional offset

offset: undefined | string
member

{string} [offset] Timespan applied to the start time of a tumbling window when evaluating dependency.

referenceTrigger

referenceTrigger: TriggerReference
member

{TriggerReference} referenceTrigger Referenced trigger.

Optional size

size: undefined | string
member

{string} [size] The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used.

serializedName

serializedName: string = "TumblingWindowTriggerDependencyReference"

type

type: object
member

{string} type Polymorphic Discriminator

className

className: string = "TumblingWindowTriggerDependencyReference"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = DependencyReference.type.polymorphicDiscriminator

uberParent

uberParent: string = "DependencyReference"

modelProperties

modelProperties: object

offset

offset: object

serializedName

serializedName: string = "offset"

constraints

constraints: object

MaxLength

MaxLength: number = 15

MinLength

MinLength: number = 8

Pattern

Pattern: RegExp = /((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9]))/

type

type: object

name

name: "String" = "String"

size

size: object

serializedName

serializedName: string = "size"

constraints

constraints: object

MaxLength

MaxLength: number = 15

MinLength

MinLength: number = 8

Pattern

Pattern: RegExp = /((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9]))/

type

type: object

name

name: "String" = "String"

Const UntilActivity

UntilActivity: object
interface

An interface representing UntilActivity. This activity executes inner activities until the specified boolean expression results to true or timeout is reached, whichever is earlier.

activities

activities: ActivityUnion[]
member

{ActivityUnion[]} activities List of activities to execute.

Optional dependsOn

dependsOn: ActivityDependency[]
member

{ActivityDependency[]} [dependsOn] Activity depends on condition.

Optional description

description: undefined | string
member

{string} [description] Activity description.

expression

expression: Expression
member

{Expression} expression An expression that would evaluate to Boolean. The loop will continue until this expression evaluates to true

name

name: string
member

{string} name Activity name.

Optional timeout

timeout: any
member

{any} [timeout] Specifies the timeout for the activity to run. If there is no value specified, it takes the value of TimeSpan.FromDays(7) which is 1 week as default. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Optional userProperties

userProperties: UserProperty[]
member

{UserProperty[]} [userProperties] Activity user properties.

serializedName

serializedName: string = "Until"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Activity.type.additionalProperties

className

className: string = "UntilActivity"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Activity.type.polymorphicDiscriminator

uberParent

uberParent: string = "Activity"

modelProperties

modelProperties: object

activities

activities: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.activities"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Activity"

name

name: "Composite" = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: "Object" = "Object"

expression

expression: object

defaultValue

defaultValue: object

Type declaration

required

required: true = true

serializedName

serializedName: string = "typeProperties.expression"

type

type: object

className

className: string = "Expression"

name

name: "Composite" = "Composite"

timeout

timeout: object

serializedName

serializedName: string = "typeProperties.timeout"

type

type: object

name

name: "Object" = "Object"

Const UpdateIntegrationRuntimeNodeRequest

UpdateIntegrationRuntimeNodeRequest: object
interface

An interface representing UpdateIntegrationRuntimeNodeRequest. Update integration runtime node request.

Optional concurrentJobsLimit

concurrentJobsLimit: undefined | number
member

{number} [concurrentJobsLimit] The number of concurrent jobs permitted to run on the integration runtime node. Values between 1 and maxConcurrentJobs(inclusive) are allowed.

serializedName

serializedName: string = "UpdateIntegrationRuntimeNodeRequest"

type

type: object

className

className: string = "UpdateIntegrationRuntimeNodeRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

concurrentJobsLimit

concurrentJobsLimit: object

serializedName

serializedName: string = "concurrentJobsLimit"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

Const UpdateIntegrationRuntimeRequest

UpdateIntegrationRuntimeRequest: object
interface

An interface representing UpdateIntegrationRuntimeRequest. Update integration runtime request.

Optional autoUpdate

member

{IntegrationRuntimeAutoUpdate} [autoUpdate] Enables or disables the auto-update feature of the self-hosted integration runtime. See https://go.microsoft.com/fwlink/?linkid=854189. Possible values include: 'On', 'Off'

Optional updateDelayOffset

updateDelayOffset: undefined | string
member

{string} [updateDelayOffset] The time offset (in hours) in the day, e.g., PT03H is 3 hours. The integration runtime auto update will happen on that time.

serializedName

serializedName: string = "UpdateIntegrationRuntimeRequest"

type

type: object

className

className: string = "UpdateIntegrationRuntimeRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

autoUpdate

autoUpdate: object

serializedName

serializedName: string = "autoUpdate"

type

type: object

name

name: "String" = "String"

updateDelayOffset

updateDelayOffset: object

serializedName

serializedName: string = "updateDelayOffset"

type

type: object

name

name: "String" = "String"

Const UserProperty

UserProperty: object
interface

An interface representing UserProperty. User property.

name

name: string
member

{string} name User proprety name.

value

value: any
member

{any} value User proprety value. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "UserProperty"

type

type: object

className

className: string = "UserProperty"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = "value"

type

type: object

name

name: "Object" = "Object"

Const VariableSpecification

VariableSpecification: object
interface

An interface representing VariableSpecification. Definition of a single variable for a Pipeline.

Optional defaultValue

defaultValue: any
member

{any} [defaultValue] Default value of variable.

serializedName

serializedName: string = "VariableSpecification"

type

type: object
member

{VariableType} type Variable type. Possible values include: 'String', 'Bool', 'Array'

className

className: string = "VariableSpecification"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

defaultValue

defaultValue: object

serializedName

serializedName: string = "defaultValue"

type

type: object

name

name: "Object" = "Object"

type

type: object

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const VerticaLinkedService

VerticaLinkedService: object
interface

An interface representing VerticaLinkedService. Vertica linked service.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional connectionString

connectionString: any
member

{any} [connectionString] An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional pwd

member

{AzureKeyVaultSecretReference} [pwd] The Azure key vault secret reference of password in connection string.

serializedName

serializedName: string = "Vertica"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "VerticaLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

connectionString

connectionString: object

serializedName

serializedName: string = "typeProperties.connectionString"

type

type: object

name

name: "Object" = "Object"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

pwd

pwd: object

serializedName

serializedName: string = "typeProperties.pwd"

type

type: object

className

className: string = "AzureKeyVaultSecretReference"

name

name: "Composite" = "Composite"

Const VerticaSource

VerticaSource: object
interface

An interface representing VerticaSource. A copy activity Vertica source.

Optional query

query: any
member

{any} [query] A query to retrieve data from source. Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "VerticaSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "VerticaSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

Const VerticaTableDataset

VerticaTableDataset: object
interface

An interface representing VerticaTableDataset. Vertica dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Optional tableName

tableName: any
member

{any} [tableName] The table name. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "VerticaTable"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "VerticaTableDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

tableName

tableName: object

serializedName

serializedName: string = "typeProperties.tableName"

type

type: object

name

name: "Object" = "Object"

Const WaitActivity

WaitActivity: object
interface

An interface representing WaitActivity. This activity suspends pipeline execution for the specified interval.

Optional dependsOn

dependsOn: ActivityDependency[]
member

{ActivityDependency[]} [dependsOn] Activity depends on condition.

Optional description

description: undefined | string
member

{string} [description] Activity description.

name

name: string
member

{string} name Activity name.

Optional userProperties

userProperties: UserProperty[]
member

{UserProperty[]} [userProperties] Activity user properties.

waitTimeInSeconds

waitTimeInSeconds: number
member

{number} waitTimeInSeconds Duration in seconds.

serializedName

serializedName: string = "Wait"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Activity.type.additionalProperties

className

className: string = "WaitActivity"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Activity.type.polymorphicDiscriminator

uberParent

uberParent: string = "Activity"

modelProperties

modelProperties: object

waitTimeInSeconds

waitTimeInSeconds: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.waitTimeInSeconds"

type

type: object

name

name: "Number" = "Number"

Const WebActivity

WebActivity: object
interface

An interface representing WebActivity. Web activity.

Optional authentication

member

{WebActivityAuthentication} [authentication] Authentication method used for calling the endpoint.

Optional body

body: any
member

{any} [body] Represents the payload that will be sent to the endpoint. Required for POST/PUT method, not allowed for GET method Type: string (or Expression with resultType string).

Optional datasets

datasets: DatasetReference[]
member

{DatasetReference[]} [datasets] List of datasets passed to web endpoint.

Optional dependsOn

dependsOn: ActivityDependency[]
member

{ActivityDependency[]} [dependsOn] Activity depends on condition.

Optional description

description: undefined | string
member

{string} [description] Activity description.

Optional headers

headers: any
member

{any} [headers] Represents the headers that will be sent to the request. For example, to set the language and type on a request: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Type: string (or Expression with resultType string).

Optional linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} [linkedServiceName] Linked service reference.

Optional linkedServices

linkedServices: LinkedServiceReference[]
member

{LinkedServiceReference[]} [linkedServices] List of linked services passed to web endpoint.

method

member

{WebActivityMethod} method Rest API method for target endpoint. Possible values include: 'GET', 'POST', 'PUT', 'DELETE'

name

name: string
member

{string} name Activity name.

Optional policy

member

{ActivityPolicy} [policy] Activity policy.

url

url: any
member

{any} url Web activity target endpoint and path. Type: string (or Expression with resultType string).

Optional userProperties

userProperties: UserProperty[]
member

{UserProperty[]} [userProperties] Activity user properties.

serializedName

serializedName: string = "WebActivity"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Activity.type.additionalProperties

className

className: string = "WebActivity"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Activity.type.polymorphicDiscriminator

uberParent

uberParent: string = "Activity"

modelProperties

modelProperties: object

authentication

authentication: object

serializedName

serializedName: string = "typeProperties.authentication"

type

type: object

className

className: string = "WebActivityAuthentication"

name

name: "Composite" = "Composite"

body

body: object

serializedName

serializedName: string = "typeProperties.body"

type

type: object

name

name: "Object" = "Object"

datasets

datasets: object

serializedName

serializedName: string = "typeProperties.datasets"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DatasetReference"

name

name: "Composite" = "Composite"

headers

headers: object

serializedName

serializedName: string = "typeProperties.headers"

type

type: object

name

name: "Object" = "Object"

linkedServices

linkedServices: object

serializedName

serializedName: string = "typeProperties.linkedServices"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LinkedServiceReference"

name

name: "Composite" = "Composite"

method

method: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.method"

type

type: object

name

name: "String" = "String"

url

url: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.url"

type

type: object

name

name: "Object" = "Object"

Const WebActivityAuthentication

WebActivityAuthentication: object
interface

An interface representing WebActivityAuthentication. Web activity authentication properties.

Optional password

password: SecureString
member

{SecureString} [password] Password for the PFX file or basic authentication.

Optional pfx

member

{SecureString} [pfx] Base64-encoded contents of a PFX file.

Optional resource

resource: undefined | string
member

{string} [resource] Resource for which Azure Auth token will be requested when using MSI Authentication.

Optional username

username: undefined | string
member

{string} [username] Web activity authentication user name for basic authentication.

serializedName

serializedName: string = "WebActivityAuthentication"

type

type: object
member

{string} type Web activity authentication (Basic/ClientCertificate/MSI)

className

className: string = "WebActivityAuthentication"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

password

password: object

serializedName

serializedName: string = "password"

type

type: object

className

className: string = "SecureString"

name

name: "Composite" = "Composite"

pfx

pfx: object

serializedName

serializedName: string = "pfx"

type

type: object

className

className: string = "SecureString"

name

name: "Composite" = "Composite"

resource

resource: object

serializedName

serializedName: string = "resource"

type

type: object

name

name: "String" = "String"

type

type: object

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

username

username: object

serializedName

serializedName: string = "username"

type

type: object

name

name: "String" = "String"

Const WebAnonymousAuthentication

WebAnonymousAuthentication: object
interface

An interface representing WebAnonymousAuthentication. A WebLinkedService that uses anonymous authentication to communicate with an HTTP endpoint.

authenticationType

authenticationType: "Anonymous"
member

{string} authenticationType Polymorphic Discriminator

url

url: any
member

{any} url The URL of the web service endpoint, e.g. http://www.microsoft.com . Type: string (or Expression with resultType string).

serializedName

serializedName: string = "Anonymous"

type

type: object

className

className: string = "WebAnonymousAuthentication"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = WebLinkedServiceTypeProperties.type.polymorphicDiscriminator

uberParent

uberParent: string = "WebLinkedServiceTypeProperties"

modelProperties

modelProperties: object

Const WebBasicAuthentication

WebBasicAuthentication: object
interface

An interface representing WebBasicAuthentication. A WebLinkedService that uses basic authentication to communicate with an HTTP endpoint.

authenticationType

authenticationType: "Basic"
member

{string} authenticationType Polymorphic Discriminator

password

password: SecretBaseUnion
member

{SecretBaseUnion} password The password for Basic authentication.

url

url: any
member

{any} url The URL of the web service endpoint, e.g. http://www.microsoft.com . Type: string (or Expression with resultType string).

username

username: any
member

{any} username User name for Basic authentication. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "Basic"

type

type: object

className

className: string = "WebBasicAuthentication"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = WebLinkedServiceTypeProperties.type.polymorphicDiscriminator

uberParent

uberParent: string = "WebLinkedServiceTypeProperties"

modelProperties

modelProperties: object

password

password: object

required

required: true = true

serializedName

serializedName: string = "password"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

username

username: object

required

required: true = true

serializedName

serializedName: string = "username"

type

type: object

name

name: "Object" = "Object"

Const WebClientCertificateAuthentication

WebClientCertificateAuthentication: object
interface

An interface representing WebClientCertificateAuthentication. A WebLinkedService that uses client certificate based authentication to communicate with an HTTP endpoint. This scheme follows mutual authentication; the server must also provide valid credentials to the client.

authenticationType

authenticationType: "ClientCertificate"
member

{string} authenticationType Polymorphic Discriminator

password

password: SecretBaseUnion
member

{SecretBaseUnion} password Password for the PFX file.

pfx

member

{SecretBaseUnion} pfx Base64-encoded contents of a PFX file.

url

url: any
member

{any} url The URL of the web service endpoint, e.g. http://www.microsoft.com . Type: string (or Expression with resultType string).

serializedName

serializedName: string = "ClientCertificate"

type

type: object

className

className: string = "WebClientCertificateAuthentication"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = WebLinkedServiceTypeProperties.type.polymorphicDiscriminator

uberParent

uberParent: string = "WebLinkedServiceTypeProperties"

modelProperties

modelProperties: object

password

password: object

required

required: true = true

serializedName

serializedName: string = "password"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

pfx

pfx: object

required

required: true = true

serializedName

serializedName: string = "pfx"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

Const WebLinkedService

WebLinkedService: object
interface

An interface representing WebLinkedService. Web linked service.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

typeProperties

member

{WebLinkedServiceTypePropertiesUnion} typeProperties Web linked service properties.

serializedName

serializedName: string = "Web"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "WebLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

typeProperties

typeProperties: object

required

required: true = true

serializedName

serializedName: string = "typeProperties"

type

type: object

className

className: string = "WebLinkedServiceTypeProperties"

name

name: "Composite" = "Composite"

Const WebLinkedServiceTypeProperties

WebLinkedServiceTypeProperties: object
interface

An interface representing WebLinkedServiceTypeProperties. Base definition of WebLinkedServiceTypeProperties, this typeProperties is polymorphic based on authenticationType, so not flattened in SDK models.

authenticationType

authenticationType: "WebLinkedServiceTypeProperties"
member

{string} authenticationType Polymorphic Discriminator

url

url: any
member

{any} url The URL of the web service endpoint, e.g. http://www.microsoft.com . Type: string (or Expression with resultType string).

serializedName

serializedName: string = "WebLinkedServiceTypeProperties"

type

type: object

className

className: string = "WebLinkedServiceTypeProperties"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "WebLinkedServiceTypeProperties"

modelProperties

modelProperties: object

authenticationType

authenticationType: object

required

required: true = true

serializedName

serializedName: string = "authenticationType"

type

type: object

name

name: "String" = "String"

url

url: object

required

required: true = true

serializedName

serializedName: string = "url"

type

type: object

name

name: "Object" = "Object"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "authenticationType"

serializedName

serializedName: string = "authenticationType"

Const WebSource

WebSource: object
interface

An interface representing WebSource. A copy activity source for web page table.

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "WebSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "WebSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

Const WebTableDataset

WebTableDataset: object
interface

An interface representing WebTableDataset. The dataset points to a HTML table in the web page.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

index

index: any
member

{any} index The zero-based index of the table in the web page. Type: integer (or Expression with resultType integer), minimum: 0.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional path

path: any
member

{any} [path] The relative URL to the web page from the linked service URL. Type: string (or Expression with resultType string).

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

serializedName

serializedName: string = "WebTable"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "WebTableDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

index

index: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.index"

type

type: object

name

name: "Object" = "Object"

path

path: object

serializedName

serializedName: string = "typeProperties.path"

type

type: object

name

name: "Object" = "Object"

Const XeroLinkedService

XeroLinkedService: object
interface

An interface representing XeroLinkedService. Xero Serivce linked service.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional consumerKey

consumerKey: SecretBaseUnion
member

{SecretBaseUnion} [consumerKey] The consumer key associated with the Xero application.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

host

host: any
member

{any} host The endpoint of the Xero server. (i.e. api.xero.com)

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional privateKey

privateKey: SecretBaseUnion
member

{SecretBaseUnion} [privateKey] The private key from the .pem file that was generated for your Xero private application. You must include all the text from the .pem file, including the Unix line endings( ).

Optional useEncryptedEndpoints

useEncryptedEndpoints: any
member

{any} [useEncryptedEndpoints] Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

Optional useHostVerification

useHostVerification: any
member

{any} [useHostVerification] Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.

Optional usePeerVerification

usePeerVerification: any
member

{any} [usePeerVerification] Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

serializedName

serializedName: string = "Xero"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "XeroLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

consumerKey

consumerKey: object

serializedName

serializedName: string = "typeProperties.consumerKey"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

host

host: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.host"

type

type: object

name

name: "Object" = "Object"

privateKey

privateKey: object

serializedName

serializedName: string = "typeProperties.privateKey"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

useEncryptedEndpoints

useEncryptedEndpoints: object

serializedName

serializedName: string = "typeProperties.useEncryptedEndpoints"

type

type: object

name

name: "Object" = "Object"

useHostVerification

useHostVerification: object

serializedName

serializedName: string = "typeProperties.useHostVerification"

type

type: object

name

name: "Object" = "Object"

usePeerVerification

usePeerVerification: object

serializedName

serializedName: string = "typeProperties.usePeerVerification"

type

type: object

name

name: "Object" = "Object"

Const XeroObjectDataset

XeroObjectDataset: object
interface

An interface representing XeroObjectDataset. Xero Serivce dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Optional tableName

tableName: any
member

{any} [tableName] The table name. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "XeroObject"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "XeroObjectDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

tableName

tableName: object

serializedName

serializedName: string = "typeProperties.tableName"

type

type: object

name

name: "Object" = "Object"

Const XeroSource

XeroSource: object
interface

An interface representing XeroSource. A copy activity Xero Serivce source.

Optional query

query: any
member

{any} [query] A query to retrieve data from source. Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "XeroSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "XeroSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

Const ZohoLinkedService

ZohoLinkedService: object
interface

An interface representing ZohoLinkedService. Zoho server linked service.

Optional accessToken

accessToken: SecretBaseUnion
member

{SecretBaseUnion} [accessToken] The access token for Zoho authentication.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional connectVia

member

{IntegrationRuntimeReference} [connectVia] The integration runtime reference.

Optional description

description: undefined | string
member

{string} [description] Linked service description.

Optional encryptedCredential

encryptedCredential: any
member

{any} [encryptedCredential] The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).

endpoint

endpoint: any
member

{any} endpoint The endpoint of the Zoho server. (i.e. crm.zoho.com/crm/private)

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for linked service.

Optional useEncryptedEndpoints

useEncryptedEndpoints: any
member

{any} [useEncryptedEndpoints] Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.

Optional useHostVerification

useHostVerification: any
member

{any} [useHostVerification] Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true.

Optional usePeerVerification

usePeerVerification: any
member

{any} [usePeerVerification] Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.

serializedName

serializedName: string = "Zoho"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = LinkedService.type.additionalProperties

className

className: string = "ZohoLinkedService"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = LinkedService.type.polymorphicDiscriminator

uberParent

uberParent: string = "LinkedService"

modelProperties

modelProperties: object

accessToken

accessToken: object

serializedName

serializedName: string = "typeProperties.accessToken"

type

type: object

className

className: string = "SecretBase"

name

name: "Composite" = "Composite"

encryptedCredential

encryptedCredential: object

serializedName

serializedName: string = "typeProperties.encryptedCredential"

type

type: object

name

name: "Object" = "Object"

endpoint

endpoint: object

required

required: true = true

serializedName

serializedName: string = "typeProperties.endpoint"

type

type: object

name

name: "Object" = "Object"

useEncryptedEndpoints

useEncryptedEndpoints: object

serializedName

serializedName: string = "typeProperties.useEncryptedEndpoints"

type

type: object

name

name: "Object" = "Object"

useHostVerification

useHostVerification: object

serializedName

serializedName: string = "typeProperties.useHostVerification"

type

type: object

name

name: "Object" = "Object"

usePeerVerification

usePeerVerification: object

serializedName

serializedName: string = "typeProperties.usePeerVerification"

type

type: object

name

name: "Object" = "Object"

Const ZohoObjectDataset

ZohoObjectDataset: object
interface

An interface representing ZohoObjectDataset. Zoho server dataset.

Optional annotations

annotations: any[]
member

{any[]} [annotations] List of tags that can be used for describing the Dataset.

Optional description

description: undefined | string
member

{string} [description] Dataset description.

Optional folder

member

{DatasetFolder} [folder] The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

linkedServiceName

linkedServiceName: LinkedServiceReference
member

{LinkedServiceReference} linkedServiceName Linked service reference.

Optional parameters

parameters: undefined | object
member

{{ [propertyName: string]: ParameterSpecification }} [parameters] Parameters for dataset.

Optional structure

structure: any
member

{any} [structure] Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Optional tableName

tableName: any
member

{any} [tableName] The table name. Type: string (or Expression with resultType string).

serializedName

serializedName: string = "ZohoObject"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = Dataset.type.additionalProperties

className

className: string = "ZohoObjectDataset"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Dataset.type.polymorphicDiscriminator

uberParent

uberParent: string = "Dataset"

modelProperties

modelProperties: object

tableName

tableName: object

serializedName

serializedName: string = "typeProperties.tableName"

type

type: object

name

name: "Object" = "Object"

Const ZohoSource

ZohoSource: object
interface

An interface representing ZohoSource. A copy activity Zoho server source.

Optional query

query: any
member

{any} [query] A query to retrieve data from source. Type: string (or Expression with resultType string).

Optional sourceRetryCount

sourceRetryCount: any
member

{any} [sourceRetryCount] Source retry count. Type: integer (or Expression with resultType integer).

Optional sourceRetryWait

sourceRetryWait: any
member

{any} [sourceRetryWait] Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

serializedName

serializedName: string = "ZohoSource"

type

type: object
member

{string} type Polymorphic Discriminator

additionalProperties

additionalProperties: undefined | CompositeMapper | BaseMapper | SequenceMapper | DictionaryMapper | EnumMapper = CopySource.type.additionalProperties

className

className: string = "ZohoSource"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = CopySource.type.polymorphicDiscriminator

uberParent

uberParent: string = "CopySource"

modelProperties

modelProperties: object

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: "Object" = "Object"

Const acceptLanguage

acceptLanguage: object

parameterPath

parameterPath: string = "acceptLanguage"

mapper

mapper: object

defaultValue

defaultValue: string = "en-US"

serializedName

serializedName: string = "accept-language"

type

type: object

name

name: "String" = "String"

Const apiVersion

apiVersion: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const datasetName

datasetName: object

parameterPath

parameterPath: string = "datasetName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "datasetName"

constraints

constraints: object

MaxLength

MaxLength: number = 260

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[A-Za-z0-9_][^<>*#.%&:\\+?\/]*$/

type

type: object

name

name: "String" = "String"

Const discriminators

discriminators: object

Activity

Activity: CompositeMapper = Activity

Activity.AppendVariable

Activity.AppendVariable: CompositeMapper = AppendVariableActivity

Activity.AzureMLBatchExecution

Activity.AzureMLBatchExecution: CompositeMapper = AzureMLBatchExecutionActivity

Activity.AzureMLUpdateResource

Activity.AzureMLUpdateResource: CompositeMapper = AzureMLUpdateResourceActivity

Activity.Container

Activity.Container: CompositeMapper = ControlActivity

Activity.Copy

Activity.Copy: CompositeMapper = CopyActivity

Activity.Custom

Activity.Custom: CompositeMapper = CustomActivity

Activity.DataLakeAnalyticsU-SQL

Activity.DataLakeAnalyticsU-SQL: CompositeMapper = DataLakeAnalyticsUSQLActivity

Activity.DatabricksNotebook

Activity.DatabricksNotebook: CompositeMapper = DatabricksNotebookActivity

Activity.DatabricksSparkJar

Activity.DatabricksSparkJar: CompositeMapper = DatabricksSparkJarActivity

Activity.DatabricksSparkPython

Activity.DatabricksSparkPython: CompositeMapper = DatabricksSparkPythonActivity

Activity.Delete

Activity.Delete: CompositeMapper = DeleteActivity

Activity.ExecutePipeline

Activity.ExecutePipeline: CompositeMapper = ExecutePipelineActivity

Activity.ExecuteSSISPackage

Activity.ExecuteSSISPackage: CompositeMapper = ExecuteSSISPackageActivity

Activity.Execution

Activity.Execution: CompositeMapper = ExecutionActivity

Activity.Filter

Activity.Filter: CompositeMapper = FilterActivity

Activity.ForEach

Activity.ForEach: CompositeMapper = ForEachActivity

Activity.GetMetadata

Activity.GetMetadata: CompositeMapper = GetMetadataActivity

Activity.HDInsightHive

Activity.HDInsightHive: CompositeMapper = HDInsightHiveActivity

Activity.HDInsightMapReduce

Activity.HDInsightMapReduce: CompositeMapper = HDInsightMapReduceActivity

Activity.HDInsightPig

Activity.HDInsightPig: CompositeMapper = HDInsightPigActivity

Activity.HDInsightSpark

Activity.HDInsightSpark: CompositeMapper = HDInsightSparkActivity

Activity.HDInsightStreaming

Activity.HDInsightStreaming: CompositeMapper = HDInsightStreamingActivity

Activity.IfCondition

Activity.IfCondition: CompositeMapper = IfConditionActivity

Activity.Lookup

Activity.Lookup: CompositeMapper = LookupActivity

Activity.SetVariable

Activity.SetVariable: CompositeMapper = SetVariableActivity

Activity.SqlServerStoredProcedure

Activity.SqlServerStoredProcedure: CompositeMapper = SqlServerStoredProcedureActivity

Activity.Until

Activity.Until: CompositeMapper = UntilActivity

Activity.Wait

Activity.Wait: CompositeMapper = WaitActivity

Activity.WebActivity

Activity.WebActivity: CompositeMapper = WebActivity

CopySink

CopySink: CompositeMapper = CopySink

CopySink.AzureDataLakeStoreSink

CopySink.AzureDataLakeStoreSink: CompositeMapper = AzureDataLakeStoreSink

CopySink.AzureQueueSink

CopySink.AzureQueueSink: CompositeMapper = AzureQueueSink

CopySink.AzureSearchIndexSink

CopySink.AzureSearchIndexSink: CompositeMapper = AzureSearchIndexSink

CopySink.AzureTableSink

CopySink.AzureTableSink: CompositeMapper = AzureTableSink

CopySink.BlobSink

CopySink.BlobSink: CompositeMapper = BlobSink

CopySink.DocumentDbCollectionSink

CopySink.DocumentDbCollectionSink: CompositeMapper = DocumentDbCollectionSink

CopySink.DynamicsSink

CopySink.DynamicsSink: CompositeMapper = DynamicsSink

CopySink.FileSystemSink

CopySink.FileSystemSink: CompositeMapper = FileSystemSink

CopySink.OdbcSink

CopySink.OdbcSink: CompositeMapper = OdbcSink

CopySink.OracleSink

CopySink.OracleSink: CompositeMapper = OracleSink

CopySink.SalesforceSink

CopySink.SalesforceSink: CompositeMapper = SalesforceSink

CopySink.SapCloudForCustomerSink

CopySink.SapCloudForCustomerSink: CompositeMapper = SapCloudForCustomerSink

CopySink.SqlDWSink

CopySink.SqlDWSink: CompositeMapper = SqlDWSink

CopySink.SqlSink

CopySink.SqlSink: CompositeMapper = SqlSink

CopySource

CopySource: CompositeMapper = CopySource

CopySource.AmazonMWSSource

CopySource.AmazonMWSSource: CompositeMapper = AmazonMWSSource

CopySource.AmazonRedshiftSource

CopySource.AmazonRedshiftSource: CompositeMapper = AmazonRedshiftSource

CopySource.AzureDataLakeStoreSource

CopySource.AzureDataLakeStoreSource: CompositeMapper = AzureDataLakeStoreSource

CopySource.AzureMySqlSource

CopySource.AzureMySqlSource: CompositeMapper = AzureMySqlSource

CopySource.AzurePostgreSqlSource

CopySource.AzurePostgreSqlSource: CompositeMapper = AzurePostgreSqlSource

CopySource.AzureTableSource

CopySource.AzureTableSource: CompositeMapper = AzureTableSource

CopySource.BlobSource

CopySource.BlobSource: CompositeMapper = BlobSource

CopySource.CassandraSource

CopySource.CassandraSource: CompositeMapper = CassandraSource

CopySource.ConcurSource

CopySource.ConcurSource: CompositeMapper = ConcurSource

CopySource.CouchbaseSource

CopySource.CouchbaseSource: CompositeMapper = CouchbaseSource

CopySource.DocumentDbCollectionSource

CopySource.DocumentDbCollectionSource: CompositeMapper = DocumentDbCollectionSource

CopySource.DrillSource

CopySource.DrillSource: CompositeMapper = DrillSource

CopySource.DynamicsSource

CopySource.DynamicsSource: CompositeMapper = DynamicsSource

CopySource.EloquaSource

CopySource.EloquaSource: CompositeMapper = EloquaSource

CopySource.FileSystemSource

CopySource.FileSystemSource: CompositeMapper = FileSystemSource

CopySource.GoogleBigQuerySource

CopySource.GoogleBigQuerySource: CompositeMapper = GoogleBigQuerySource

CopySource.GreenplumSource

CopySource.GreenplumSource: CompositeMapper = GreenplumSource

CopySource.HBaseSource

CopySource.HBaseSource: CompositeMapper = HBaseSource

CopySource.HdfsSource

CopySource.HdfsSource: CompositeMapper = HdfsSource

CopySource.HiveSource

CopySource.HiveSource: CompositeMapper = HiveSource

CopySource.HttpSource

CopySource.HttpSource: CompositeMapper = HttpSource

CopySource.HubspotSource

CopySource.HubspotSource: CompositeMapper = HubspotSource

CopySource.ImpalaSource

CopySource.ImpalaSource: CompositeMapper = ImpalaSource

CopySource.JiraSource

CopySource.JiraSource: CompositeMapper = JiraSource

CopySource.MagentoSource

CopySource.MagentoSource: CompositeMapper = MagentoSource

CopySource.MariaDBSource

CopySource.MariaDBSource: CompositeMapper = MariaDBSource

CopySource.MarketoSource

CopySource.MarketoSource: CompositeMapper = MarketoSource

CopySource.MongoDbSource

CopySource.MongoDbSource: CompositeMapper = MongoDbSource

CopySource.NetezzaSource

CopySource.NetezzaSource: CompositeMapper = NetezzaSource

CopySource.OracleSource

CopySource.OracleSource: CompositeMapper = OracleSource

CopySource.PaypalSource

CopySource.PaypalSource: CompositeMapper = PaypalSource

CopySource.PhoenixSource

CopySource.PhoenixSource: CompositeMapper = PhoenixSource

CopySource.PrestoSource

CopySource.PrestoSource: CompositeMapper = PrestoSource

CopySource.QuickBooksSource

CopySource.QuickBooksSource: CompositeMapper = QuickBooksSource

CopySource.RelationalSource

CopySource.RelationalSource: CompositeMapper = RelationalSource

CopySource.ResponsysSource

CopySource.ResponsysSource: CompositeMapper = ResponsysSource

CopySource.SalesforceMarketingCloudSource

CopySource.SalesforceMarketingCloudSource: CompositeMapper = SalesforceMarketingCloudSource

CopySource.SalesforceSource

CopySource.SalesforceSource: CompositeMapper = SalesforceSource

CopySource.SapCloudForCustomerSource

CopySource.SapCloudForCustomerSource: CompositeMapper = SapCloudForCustomerSource

CopySource.SapEccSource

CopySource.SapEccSource: CompositeMapper = SapEccSource

CopySource.ServiceNowSource

CopySource.ServiceNowSource: CompositeMapper = ServiceNowSource

CopySource.ShopifySource

CopySource.ShopifySource: CompositeMapper = ShopifySource

CopySource.SparkSource

CopySource.SparkSource: CompositeMapper = SparkSource

CopySource.SqlDWSource

CopySource.SqlDWSource: CompositeMapper = SqlDWSource

CopySource.SqlSource

CopySource.SqlSource: CompositeMapper = SqlSource

CopySource.SquareSource

CopySource.SquareSource: CompositeMapper = SquareSource

CopySource.VerticaSource

CopySource.VerticaSource: CompositeMapper = VerticaSource

CopySource.WebSource

CopySource.WebSource: CompositeMapper = WebSource

CopySource.XeroSource

CopySource.XeroSource: CompositeMapper = XeroSource

CopySource.ZohoSource

CopySource.ZohoSource: CompositeMapper = ZohoSource

CopyTranslator

CopyTranslator: CompositeMapper = CopyTranslator

CopyTranslator.TabularTranslator

CopyTranslator.TabularTranslator: CompositeMapper = TabularTranslator

Dataset

Dataset: CompositeMapper = Dataset

Dataset.AmazonMWSObject

Dataset.AmazonMWSObject: CompositeMapper = AmazonMWSObjectDataset

Dataset.AmazonS3Object

Dataset.AmazonS3Object: CompositeMapper = AmazonS3Dataset

Dataset.AzureBlob

Dataset.AzureBlob: CompositeMapper = AzureBlobDataset

Dataset.AzureDataLakeStoreFile

Dataset.AzureDataLakeStoreFile: CompositeMapper = AzureDataLakeStoreDataset

Dataset.AzureMySqlTable

Dataset.AzureMySqlTable: CompositeMapper = AzureMySqlTableDataset

Dataset.AzurePostgreSqlTable

Dataset.AzurePostgreSqlTable: CompositeMapper = AzurePostgreSqlTableDataset

Dataset.AzureSearchIndex

Dataset.AzureSearchIndex: CompositeMapper = AzureSearchIndexDataset

Dataset.AzureSqlDWTable

Dataset.AzureSqlDWTable: CompositeMapper = AzureSqlDWTableDataset

Dataset.AzureSqlTable

Dataset.AzureSqlTable: CompositeMapper = AzureSqlTableDataset

Dataset.AzureTable

Dataset.AzureTable: CompositeMapper = AzureTableDataset

Dataset.CassandraTable

Dataset.CassandraTable: CompositeMapper = CassandraTableDataset

Dataset.ConcurObject

Dataset.ConcurObject: CompositeMapper = ConcurObjectDataset

Dataset.CouchbaseTable

Dataset.CouchbaseTable: CompositeMapper = CouchbaseTableDataset

Dataset.CustomDataset

Dataset.CustomDataset: CompositeMapper = CustomDataset

Dataset.DocumentDbCollection

Dataset.DocumentDbCollection: CompositeMapper = DocumentDbCollectionDataset

Dataset.DrillTable

Dataset.DrillTable: CompositeMapper = DrillTableDataset

Dataset.DynamicsEntity

Dataset.DynamicsEntity: CompositeMapper = DynamicsEntityDataset

Dataset.EloquaObject

Dataset.EloquaObject: CompositeMapper = EloquaObjectDataset

Dataset.FileShare

Dataset.FileShare: CompositeMapper = FileShareDataset

Dataset.GoogleBigQueryObject

Dataset.GoogleBigQueryObject: CompositeMapper = GoogleBigQueryObjectDataset

Dataset.GreenplumTable

Dataset.GreenplumTable: CompositeMapper = GreenplumTableDataset

Dataset.HBaseObject

Dataset.HBaseObject: CompositeMapper = HBaseObjectDataset

Dataset.HiveObject

Dataset.HiveObject: CompositeMapper = HiveObjectDataset

Dataset.HttpFile

Dataset.HttpFile: CompositeMapper = HttpDataset

Dataset.HubspotObject

Dataset.HubspotObject: CompositeMapper = HubspotObjectDataset

Dataset.ImpalaObject

Dataset.ImpalaObject: CompositeMapper = ImpalaObjectDataset

Dataset.JiraObject

Dataset.JiraObject: CompositeMapper = JiraObjectDataset

Dataset.MagentoObject

Dataset.MagentoObject: CompositeMapper = MagentoObjectDataset

Dataset.MariaDBTable

Dataset.MariaDBTable: CompositeMapper = MariaDBTableDataset

Dataset.MarketoObject

Dataset.MarketoObject: CompositeMapper = MarketoObjectDataset

Dataset.MongoDbCollection

Dataset.MongoDbCollection: CompositeMapper = MongoDbCollectionDataset

Dataset.NetezzaTable

Dataset.NetezzaTable: CompositeMapper = NetezzaTableDataset

Dataset.ODataResource

Dataset.ODataResource: CompositeMapper = ODataResourceDataset

Dataset.OracleTable

Dataset.OracleTable: CompositeMapper = OracleTableDataset

Dataset.PaypalObject

Dataset.PaypalObject: CompositeMapper = PaypalObjectDataset

Dataset.PhoenixObject

Dataset.PhoenixObject: CompositeMapper = PhoenixObjectDataset

Dataset.PrestoObject

Dataset.PrestoObject: CompositeMapper = PrestoObjectDataset

Dataset.QuickBooksObject

Dataset.QuickBooksObject: CompositeMapper = QuickBooksObjectDataset

Dataset.RelationalTable

Dataset.RelationalTable: CompositeMapper = RelationalTableDataset

Dataset.ResponsysObject

Dataset.ResponsysObject: CompositeMapper = ResponsysObjectDataset

Dataset.SalesforceMarketingCloudObject

Dataset.SalesforceMarketingCloudObject: CompositeMapper = SalesforceMarketingCloudObjectDataset

Dataset.SalesforceObject

Dataset.SalesforceObject: CompositeMapper = SalesforceObjectDataset

Dataset.SapCloudForCustomerResource

Dataset.SapCloudForCustomerResource: CompositeMapper = SapCloudForCustomerResourceDataset

Dataset.SapEccResource

Dataset.SapEccResource: CompositeMapper = SapEccResourceDataset

Dataset.ServiceNowObject

Dataset.ServiceNowObject: CompositeMapper = ServiceNowObjectDataset

Dataset.ShopifyObject

Dataset.ShopifyObject: CompositeMapper = ShopifyObjectDataset

Dataset.SparkObject

Dataset.SparkObject: CompositeMapper = SparkObjectDataset

Dataset.SqlServerTable

Dataset.SqlServerTable: CompositeMapper = SqlServerTableDataset

Dataset.SquareObject

Dataset.SquareObject: CompositeMapper = SquareObjectDataset

Dataset.VerticaTable

Dataset.VerticaTable: CompositeMapper = VerticaTableDataset

Dataset.WebTable

Dataset.WebTable: CompositeMapper = WebTableDataset

Dataset.XeroObject

Dataset.XeroObject: CompositeMapper = XeroObjectDataset

Dataset.ZohoObject

Dataset.ZohoObject: CompositeMapper = ZohoObjectDataset

DatasetCompression

DatasetCompression: CompositeMapper = DatasetCompression

DatasetCompression.BZip2

DatasetCompression.BZip2: CompositeMapper = DatasetBZip2Compression

DatasetCompression.Deflate

DatasetCompression.Deflate: CompositeMapper = DatasetDeflateCompression

DatasetCompression.GZip

DatasetCompression.GZip: CompositeMapper = DatasetGZipCompression

DatasetCompression.ZipDeflate

DatasetCompression.ZipDeflate: CompositeMapper = DatasetZipDeflateCompression

DatasetStorageFormat

DatasetStorageFormat: CompositeMapper = DatasetStorageFormat

DatasetStorageFormat.AvroFormat

DatasetStorageFormat.AvroFormat: CompositeMapper = AvroFormat

DatasetStorageFormat.JsonFormat

DatasetStorageFormat.JsonFormat: CompositeMapper = JsonFormat

DatasetStorageFormat.OrcFormat

DatasetStorageFormat.OrcFormat: CompositeMapper = OrcFormat

DatasetStorageFormat.ParquetFormat

DatasetStorageFormat.ParquetFormat: CompositeMapper = ParquetFormat

DatasetStorageFormat.TextFormat

DatasetStorageFormat.TextFormat: CompositeMapper = TextFormat

DependencyReference

DependencyReference: CompositeMapper = DependencyReference

DependencyReference.SelfDependencyTumblingWindowTriggerReference

DependencyReference.SelfDependencyTumblingWindowTriggerReference: CompositeMapper = SelfDependencyTumblingWindowTriggerReference

DependencyReference.TriggerDependencyReference

DependencyReference.TriggerDependencyReference: CompositeMapper = TriggerDependencyReference

DependencyReference.TumblingWindowTriggerDependencyReference

DependencyReference.TumblingWindowTriggerDependencyReference: CompositeMapper = TumblingWindowTriggerDependencyReference

FactoryRepoConfiguration

FactoryRepoConfiguration: CompositeMapper = FactoryRepoConfiguration

FactoryRepoConfiguration.FactoryGitHubConfiguration

FactoryRepoConfiguration.FactoryGitHubConfiguration: CompositeMapper = FactoryGitHubConfiguration

FactoryRepoConfiguration.FactoryVSTSConfiguration

FactoryRepoConfiguration.FactoryVSTSConfiguration: CompositeMapper = FactoryVSTSConfiguration

IntegrationRuntime

IntegrationRuntime: CompositeMapper = IntegrationRuntime

IntegrationRuntime.Managed

IntegrationRuntime.Managed: CompositeMapper = ManagedIntegrationRuntime

IntegrationRuntime.SelfHosted

IntegrationRuntime.SelfHosted: CompositeMapper = SelfHostedIntegrationRuntime

IntegrationRuntimeStatus

IntegrationRuntimeStatus: CompositeMapper = IntegrationRuntimeStatus

IntegrationRuntimeStatus.Managed

IntegrationRuntimeStatus.Managed: CompositeMapper = ManagedIntegrationRuntimeStatus

IntegrationRuntimeStatus.SelfHosted

IntegrationRuntimeStatus.SelfHosted: CompositeMapper = SelfHostedIntegrationRuntimeStatus

LinkedIntegrationRuntimeType

LinkedIntegrationRuntimeType: CompositeMapper = LinkedIntegrationRuntimeType

LinkedIntegrationRuntimeType.Key

LinkedIntegrationRuntimeType.Key: CompositeMapper = LinkedIntegrationRuntimeKeyAuthorization

LinkedIntegrationRuntimeType.RBAC

LinkedIntegrationRuntimeType.RBAC: CompositeMapper = LinkedIntegrationRuntimeRbacAuthorization

LinkedService

LinkedService: CompositeMapper = LinkedService

LinkedService.AmazonMWS

LinkedService.AmazonMWS: CompositeMapper = AmazonMWSLinkedService

LinkedService.AmazonRedshift

LinkedService.AmazonRedshift: CompositeMapper = AmazonRedshiftLinkedService

LinkedService.AmazonS3

LinkedService.AmazonS3: CompositeMapper = AmazonS3LinkedService

LinkedService.AzureBatch

LinkedService.AzureBatch: CompositeMapper = AzureBatchLinkedService

LinkedService.AzureBlobStorage

LinkedService.AzureBlobStorage: CompositeMapper = AzureBlobStorageLinkedService

LinkedService.AzureDataLakeAnalytics

LinkedService.AzureDataLakeAnalytics: CompositeMapper = AzureDataLakeAnalyticsLinkedService

LinkedService.AzureDataLakeStore

LinkedService.AzureDataLakeStore: CompositeMapper = AzureDataLakeStoreLinkedService

LinkedService.AzureDatabricks

LinkedService.AzureDatabricks: CompositeMapper = AzureDatabricksLinkedService

LinkedService.AzureKeyVault

LinkedService.AzureKeyVault: CompositeMapper = AzureKeyVaultLinkedService

LinkedService.AzureML

LinkedService.AzureML: CompositeMapper = AzureMLLinkedService

LinkedService.AzureMySql

LinkedService.AzureMySql: CompositeMapper = AzureMySqlLinkedService

LinkedService.AzurePostgreSql

LinkedService.AzurePostgreSql: CompositeMapper = AzurePostgreSqlLinkedService

LinkedService.AzureSearch

LinkedService.AzureSearch: CompositeMapper = AzureSearchLinkedService

LinkedService.AzureSqlDW

LinkedService.AzureSqlDW: CompositeMapper = AzureSqlDWLinkedService

LinkedService.AzureSqlDatabase

LinkedService.AzureSqlDatabase: CompositeMapper = AzureSqlDatabaseLinkedService

LinkedService.AzureStorage

LinkedService.AzureStorage: CompositeMapper = AzureStorageLinkedService

LinkedService.AzureTableStorage

LinkedService.AzureTableStorage: CompositeMapper = AzureTableStorageLinkedService

LinkedService.Cassandra

LinkedService.Cassandra: CompositeMapper = CassandraLinkedService

LinkedService.Concur

LinkedService.Concur: CompositeMapper = ConcurLinkedService

LinkedService.CosmosDb

LinkedService.CosmosDb: CompositeMapper = CosmosDbLinkedService

LinkedService.Couchbase

LinkedService.Couchbase: CompositeMapper = CouchbaseLinkedService

LinkedService.CustomDataSource

LinkedService.CustomDataSource: CompositeMapper = CustomDataSourceLinkedService

LinkedService.Db2

LinkedService.Db2: CompositeMapper = Db2LinkedService

LinkedService.Drill

LinkedService.Drill: CompositeMapper = DrillLinkedService

LinkedService.Dynamics

LinkedService.Dynamics: CompositeMapper = DynamicsLinkedService

LinkedService.Eloqua

LinkedService.Eloqua: CompositeMapper = EloquaLinkedService

LinkedService.FileServer

LinkedService.FileServer: CompositeMapper = FileServerLinkedService

LinkedService.FtpServer

LinkedService.FtpServer: CompositeMapper = FtpServerLinkedService

LinkedService.GoogleBigQuery

LinkedService.GoogleBigQuery: CompositeMapper = GoogleBigQueryLinkedService

LinkedService.Greenplum

LinkedService.Greenplum: CompositeMapper = GreenplumLinkedService

LinkedService.HBase

LinkedService.HBase: CompositeMapper = HBaseLinkedService

LinkedService.HDInsight

LinkedService.HDInsight: CompositeMapper = HDInsightLinkedService

LinkedService.HDInsightOnDemand

LinkedService.HDInsightOnDemand: CompositeMapper = HDInsightOnDemandLinkedService

LinkedService.Hdfs

LinkedService.Hdfs: CompositeMapper = HdfsLinkedService

LinkedService.Hive

LinkedService.Hive: CompositeMapper = HiveLinkedService

LinkedService.HttpServer

LinkedService.HttpServer: CompositeMapper = HttpLinkedService

LinkedService.Hubspot

LinkedService.Hubspot: CompositeMapper = HubspotLinkedService

LinkedService.Impala

LinkedService.Impala: CompositeMapper = ImpalaLinkedService

LinkedService.Jira

LinkedService.Jira: CompositeMapper = JiraLinkedService

LinkedService.Magento

LinkedService.Magento: CompositeMapper = MagentoLinkedService

LinkedService.MariaDB

LinkedService.MariaDB: CompositeMapper = MariaDBLinkedService

LinkedService.Marketo

LinkedService.Marketo: CompositeMapper = MarketoLinkedService

LinkedService.MongoDb

LinkedService.MongoDb: CompositeMapper = MongoDbLinkedService

LinkedService.MySql

LinkedService.MySql: CompositeMapper = MySqlLinkedService

LinkedService.Netezza

LinkedService.Netezza: CompositeMapper = NetezzaLinkedService

LinkedService.OData

LinkedService.OData: CompositeMapper = ODataLinkedService

LinkedService.Odbc

LinkedService.Odbc: CompositeMapper = OdbcLinkedService

LinkedService.Oracle

LinkedService.Oracle: CompositeMapper = OracleLinkedService

LinkedService.Paypal

LinkedService.Paypal: CompositeMapper = PaypalLinkedService

LinkedService.Phoenix

LinkedService.Phoenix: CompositeMapper = PhoenixLinkedService

LinkedService.PostgreSql

LinkedService.PostgreSql: CompositeMapper = PostgreSqlLinkedService

LinkedService.Presto

LinkedService.Presto: CompositeMapper = PrestoLinkedService

LinkedService.QuickBooks

LinkedService.QuickBooks: CompositeMapper = QuickBooksLinkedService

LinkedService.Responsys

LinkedService.Responsys: CompositeMapper = ResponsysLinkedService

LinkedService.Salesforce

LinkedService.Salesforce: CompositeMapper = SalesforceLinkedService

LinkedService.SalesforceMarketingCloud

LinkedService.SalesforceMarketingCloud: CompositeMapper = SalesforceMarketingCloudLinkedService

LinkedService.SapBW

LinkedService.SapBW: CompositeMapper = SapBWLinkedService

LinkedService.SapCloudForCustomer

LinkedService.SapCloudForCustomer: CompositeMapper = SapCloudForCustomerLinkedService

LinkedService.SapEcc

LinkedService.SapEcc: CompositeMapper = SapEccLinkedService

LinkedService.SapHana

LinkedService.SapHana: CompositeMapper = SapHanaLinkedService

LinkedService.ServiceNow

LinkedService.ServiceNow: CompositeMapper = ServiceNowLinkedService

LinkedService.Sftp

LinkedService.Sftp: CompositeMapper = SftpServerLinkedService

LinkedService.Shopify

LinkedService.Shopify: CompositeMapper = ShopifyLinkedService

LinkedService.Spark

LinkedService.Spark: CompositeMapper = SparkLinkedService

LinkedService.SqlServer

LinkedService.SqlServer: CompositeMapper = SqlServerLinkedService

LinkedService.Square

LinkedService.Square: CompositeMapper = SquareLinkedService

LinkedService.Sybase

LinkedService.Sybase: CompositeMapper = SybaseLinkedService

LinkedService.Teradata

LinkedService.Teradata: CompositeMapper = TeradataLinkedService

LinkedService.Vertica

LinkedService.Vertica: CompositeMapper = VerticaLinkedService

LinkedService.Web

LinkedService.Web: CompositeMapper = WebLinkedService

LinkedService.Xero

LinkedService.Xero: CompositeMapper = XeroLinkedService

LinkedService.Zoho

LinkedService.Zoho: CompositeMapper = ZohoLinkedService

SecretBase

SecretBase: CompositeMapper = SecretBase

SecretBase.AzureKeyVaultSecret

SecretBase.AzureKeyVaultSecret: CompositeMapper = AzureKeyVaultSecretReference

SecretBase.SecureString

SecretBase.SecureString: CompositeMapper = SecureString

Trigger

Trigger: CompositeMapper = Trigger

Trigger.BlobEventsTrigger

Trigger.BlobEventsTrigger: CompositeMapper = BlobEventsTrigger

Trigger.BlobTrigger

Trigger.BlobTrigger: CompositeMapper = BlobTrigger

Trigger.MultiplePipelineTrigger

Trigger.MultiplePipelineTrigger: CompositeMapper = MultiplePipelineTrigger

Trigger.RerunTumblingWindowTrigger

Trigger.RerunTumblingWindowTrigger: CompositeMapper = RerunTumblingWindowTrigger

Trigger.ScheduleTrigger

Trigger.ScheduleTrigger: CompositeMapper = ScheduleTrigger

Trigger.TumblingWindowTrigger

Trigger.TumblingWindowTrigger: CompositeMapper = TumblingWindowTrigger

WebLinkedServiceTypeProperties

WebLinkedServiceTypeProperties: CompositeMapper = WebLinkedServiceTypeProperties

WebLinkedServiceTypeProperties.Anonymous

WebLinkedServiceTypeProperties.Anonymous: CompositeMapper = WebAnonymousAuthentication

WebLinkedServiceTypeProperties.Basic

WebLinkedServiceTypeProperties.Basic: CompositeMapper = WebBasicAuthentication

WebLinkedServiceTypeProperties.ClientCertificate

WebLinkedServiceTypeProperties.ClientCertificate: CompositeMapper = WebClientCertificateAuthentication

Const factoryName

factoryName: object

parameterPath

parameterPath: string = "factoryName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "factoryName"

constraints

constraints: object

MaxLength

MaxLength: number = 63

MinLength

MinLength: number = 3

Pattern

Pattern: RegExp = /^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$/

type

type: object

name

name: "String" = "String"

Const ifMatch

ifMatch: object

parameterPath

parameterPath: string[] = ["options","ifMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-Match"

type

type: object

name

name: "String" = "String"

Const ifNoneMatch

ifNoneMatch: object

parameterPath

parameterPath: string[] = ["options","ifNoneMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-None-Match"

type

type: object

name

name: "String" = "String"

Const integrationRuntimeName

integrationRuntimeName: object

parameterPath

parameterPath: string = "integrationRuntimeName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "integrationRuntimeName"

constraints

constraints: object

MaxLength

MaxLength: number = 63

MinLength

MinLength: number = 3

Pattern

Pattern: RegExp = /^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$/

type

type: object

name

name: "String" = "String"

Const isRecursive

isRecursive: object

parameterPath

parameterPath: string[] = ["options","isRecursive"]

mapper

mapper: object

serializedName

serializedName: string = "isRecursive"

type

type: object

name

name: "Boolean" = "Boolean"

Const linkedServiceName

linkedServiceName: object

parameterPath

parameterPath: string = "linkedServiceName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "linkedServiceName"

constraints

constraints: object

MaxLength

MaxLength: number = 260

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[A-Za-z0-9_][^<>*#.%&:\\+?\/]*$/

type

type: object

name

name: "String" = "String"

Const locationId

locationId: object

parameterPath

parameterPath: string = "locationId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "locationId"

type

type: object

name

name: "String" = "String"

Const nextPageLink

nextPageLink: object

parameterPath

parameterPath: string = "nextPageLink"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

Const nodeName

nodeName: object

parameterPath

parameterPath: string = "nodeName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "nodeName"

constraints

constraints: object

MaxLength

MaxLength: number = 150

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[a-z0-9A-Z][a-z0-9A-Z_-]{0,149}$/

type

type: object

name

name: "String" = "String"

Const pipelineName

pipelineName: object

parameterPath

parameterPath: string = "pipelineName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "pipelineName"

constraints

constraints: object

MaxLength

MaxLength: number = 260

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[A-Za-z0-9_][^<>*#.%&:\\+?\/]*$/

type

type: object

name

name: "String" = "String"

Const referencePipelineRunId

referencePipelineRunId: object

parameterPath

parameterPath: string[] = ["options","referencePipelineRunId"]

mapper

mapper: object

serializedName

serializedName: string = "referencePipelineRunId"

type

type: object

name

name: "String" = "String"

Const rerunTriggerName

rerunTriggerName: object

parameterPath

parameterPath: string = "rerunTriggerName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "rerunTriggerName"

constraints

constraints: object

MaxLength

MaxLength: number = 260

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[A-Za-z0-9_][^<>*#.%&:\\+?\/]*$/

type

type: object

name

name: "String" = "String"

Const resourceGroupName

resourceGroupName: object

parameterPath

parameterPath: string = "resourceGroupName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "resourceGroupName"

constraints

constraints: object

MaxLength

MaxLength: number = 90

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[-\w\._\(\)]+$/

type

type: object

name

name: "String" = "String"

Const runId

runId: object

parameterPath

parameterPath: string = "runId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "runId"

type

type: object

name

name: "String" = "String"

Const subscriptionId

subscriptionId: object

parameterPath

parameterPath: string = "subscriptionId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "subscriptionId"

type

type: object

name

name: "String" = "String"

Const triggerName

triggerName: object

parameterPath

parameterPath: string = "triggerName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "triggerName"

constraints

constraints: object

MaxLength

MaxLength: number = 260

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[A-Za-z0-9_][^<>*#.%&:\\+?\/]*$/

type

type: object

name

name: "String" = "String"

Generated using TypeDoc